)]}'
{"goals/train/pdf-doc-generation.rst":[{"author":{"_account_id":15334,"name":"Stephen Finucane","display_name":"stephenfin","email":"stephenfin@redhat.com","username":"sfinucan"},"change_message_id":"d5b65e3d02d5ded53ffe9e12a26edd247db574e5","unresolved":false,"context_lines":[{"line_number":18,"context_line":"to further our goal of being an accessible open source community."},{"line_number":19,"context_line":""},{"line_number":20,"context_line":"Champion"},{"line_number":21,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":22,"context_line":""},{"line_number":23,"context_line":"Alexandra Settle (asettle) - SUSE"},{"line_number":24,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"5fc1f717_929b7015","line":21,"range":{"start_line":21,"start_character":0,"end_line":21,"end_character":8},"updated":"2019-03-26 11:13:12.000000000","message":"nit: unless the rest of these doc uses this style, I _think_ the style guide suggests \u0027---\u0027 for h2 headers","commit_id":"21b31fc7f198ec97193174c32d340a5cefc35e23"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"14dae9ea9828f4df57b711b8de7410af0b83b1b5","unresolved":false,"context_lines":[{"line_number":18,"context_line":"to further our goal of being an accessible open source community."},{"line_number":19,"context_line":""},{"line_number":20,"context_line":"Champion"},{"line_number":21,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":22,"context_line":""},{"line_number":23,"context_line":"Alexandra Settle (asettle) - SUSE"},{"line_number":24,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"5fc1f717_32a5dc47","line":21,"range":{"start_line":21,"start_character":0,"end_line":21,"end_character":8},"in_reply_to":"5fc1f717_929b7015","updated":"2019-03-26 11:14:53.000000000","message":"This is the draft for the governance repo. Not my drama, llama :)","commit_id":"21b31fc7f198ec97193174c32d340a5cefc35e23"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"618bf6ec0b90f06fa352939b871137e181dd0f6f","unresolved":false,"context_lines":[{"line_number":34,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":35,"context_line":""},{"line_number":36,"context_line":"The completion criteria for this goal is as follows:"},{"line_number":37,"context_line":""},{"line_number":38,"context_line":"#. Ensure documents (such as the User Guide and Administration Guide) are"},{"line_number":39,"context_line":"   able to be successfully built into a PDF format from rst-based documents"},{"line_number":40,"context_line":"   using Sphinx."},{"line_number":41,"context_line":""},{"line_number":42,"context_line":"   This would be determined by ensuring that PDF documents are generated"},{"line_number":43,"context_line":"   when the following command is run:"}],"source_content_type":"text/x-rst","patch_set":1,"id":"5fc1f717_5204284a","line":40,"range":{"start_line":37,"start_character":0,"end_line":40,"end_character":16},"updated":"2019-03-26 11:12:30.000000000","message":"User Guide?\n\nAre you talking about as an example: Provide the full content of doc/source from the nova repository as a single PDF file?\n\nThen rework the text above.","commit_id":"21b31fc7f198ec97193174c32d340a5cefc35e23"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"14dae9ea9828f4df57b711b8de7410af0b83b1b5","unresolved":false,"context_lines":[{"line_number":34,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":35,"context_line":""},{"line_number":36,"context_line":"The completion criteria for this goal is as follows:"},{"line_number":37,"context_line":""},{"line_number":38,"context_line":"#. Ensure documents (such as the User Guide and Administration Guide) are"},{"line_number":39,"context_line":"   able to be successfully built into a PDF format from rst-based documents"},{"line_number":40,"context_line":"   using Sphinx."},{"line_number":41,"context_line":""},{"line_number":42,"context_line":"   This would be determined by ensuring that PDF documents are generated"},{"line_number":43,"context_line":"   when the following command is run:"}],"source_content_type":"text/x-rst","patch_set":1,"id":"5fc1f717_d2633819","line":40,"range":{"start_line":37,"start_character":0,"end_line":40,"end_character":16},"in_reply_to":"5fc1f717_5204284a","updated":"2019-03-26 11:14:53.000000000","message":"Good point. Will do!","commit_id":"21b31fc7f198ec97193174c32d340a5cefc35e23"},{"author":{"_account_id":15334,"name":"Stephen Finucane","display_name":"stephenfin","email":"stephenfin@redhat.com","username":"sfinucan"},"change_message_id":"d5b65e3d02d5ded53ffe9e12a26edd247db574e5","unresolved":false,"context_lines":[{"line_number":42,"context_line":"   This would be determined by ensuring that PDF documents are generated"},{"line_number":43,"context_line":"   when the following command is run:"},{"line_number":44,"context_line":""},{"line_number":45,"context_line":"   .. code::"},{"line_number":46,"context_line":""},{"line_number":47,"context_line":"      $ tox -e docs"},{"line_number":48,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"5fc1f717_128f80cd","line":45,"range":{"start_line":45,"start_character":6,"end_line":45,"end_character":12},"updated":"2019-03-26 11:13:12.000000000","message":"nit: code-block:: shell","commit_id":"21b31fc7f198ec97193174c32d340a5cefc35e23"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"14dae9ea9828f4df57b711b8de7410af0b83b1b5","unresolved":false,"context_lines":[{"line_number":42,"context_line":"   This would be determined by ensuring that PDF documents are generated"},{"line_number":43,"context_line":"   when the following command is run:"},{"line_number":44,"context_line":""},{"line_number":45,"context_line":"   .. code::"},{"line_number":46,"context_line":""},{"line_number":47,"context_line":"      $ tox -e docs"},{"line_number":48,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"5fc1f717_f268b4f5","line":45,"range":{"start_line":45,"start_character":6,"end_line":45,"end_character":12},"in_reply_to":"5fc1f717_128f80cd","updated":"2019-03-26 11:14:53.000000000","message":"Aye fair","commit_id":"21b31fc7f198ec97193174c32d340a5cefc35e23"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"618bf6ec0b90f06fa352939b871137e181dd0f6f","unresolved":false,"context_lines":[{"line_number":44,"context_line":""},{"line_number":45,"context_line":"   .. code::"},{"line_number":46,"context_line":""},{"line_number":47,"context_line":"      $ tox -e docs"},{"line_number":48,"context_line":""},{"line_number":49,"context_line":"References"},{"line_number":50,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"}],"source_content_type":"text/x-rst","patch_set":1,"id":"5fc1f717_f29af411","line":47,"updated":"2019-03-26 11:12:30.000000000","message":"Which will force all users to install latex to build documentation - do we want this?","commit_id":"21b31fc7f198ec97193174c32d340a5cefc35e23"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"a8483f8d020473740c441d73cc1a9c3f2c7b27cb","unresolved":false,"context_lines":[{"line_number":44,"context_line":""},{"line_number":45,"context_line":"   .. code::"},{"line_number":46,"context_line":""},{"line_number":47,"context_line":"      $ tox -e docs"},{"line_number":48,"context_line":""},{"line_number":49,"context_line":"References"},{"line_number":50,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"}],"source_content_type":"text/x-rst","patch_set":1,"id":"5fc1f717_5522d253","line":47,"in_reply_to":"5fc1f717_127d40b1","updated":"2019-03-26 11:38:09.000000000","message":"you need to add to bindep.txt the texlive and etc commands we need to be able to build, see what we have in openstack-manuals...\n\nYes, it makes it simple in gate etc - but it makes it difficult for developers to test since they need to install more. Let\u0027s see what gets debated.\n\nBtw. you need to take care of publishing of PDF file in tox.ini: the commands to build the PDF need to copy it to a place that gets published.","commit_id":"21b31fc7f198ec97193174c32d340a5cefc35e23"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"14dae9ea9828f4df57b711b8de7410af0b83b1b5","unresolved":false,"context_lines":[{"line_number":44,"context_line":""},{"line_number":45,"context_line":"   .. code::"},{"line_number":46,"context_line":""},{"line_number":47,"context_line":"      $ tox -e docs"},{"line_number":48,"context_line":""},{"line_number":49,"context_line":"References"},{"line_number":50,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"}],"source_content_type":"text/x-rst","patch_set":1,"id":"5fc1f717_127d40b1","line":47,"in_reply_to":"5fc1f717_f29af411","updated":"2019-03-26 11:14:53.000000000","message":"Good question. I leave this up for debate. Is there a downside to enforcing this? It would make the overall generation at the end simple?","commit_id":"21b31fc7f198ec97193174c32d340a5cefc35e23"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"ef4bd45fe4c178441eedcbe72302fda087adfb59","unresolved":false,"context_lines":[{"line_number":4,"context_line":""},{"line_number":5,"context_line":"During the Ocata cycle, the OpenStack-manuals, infra, and translations"},{"line_number":6,"context_line":"team worked together to enable the generation of PDF doc files from"},{"line_number":7,"context_line":"rst-based guide documents. This change provided PDF download URLs to"},{"line_number":8,"context_line":"each HTML document, allowing users who want to see documents offline"},{"line_number":9,"context_line":"the ability to do so."},{"line_number":10,"context_line":""},{"line_number":11,"context_line":"The work was completed at the end of the Ocata release, but was never"}],"source_content_type":"text/x-rst","patch_set":2,"id":"5fc1f717_3b7b678c","line":8,"range":{"start_line":7,"start_character":27,"end_line":8,"end_character":18},"updated":"2019-03-26 22:10:40.000000000","message":"So relative urls between PDFs?\n\nEach HTML document as a single guide document, or broken up based upon how teams have organized the data. The reason I\u0027m worried about this is we presently generate 592 HTML files in ironic and any effort to change/restructure documentation has been highly highly contentious","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"c93cfc46cc395a11e8255503e7805b2cdb0ed92c","unresolved":false,"context_lines":[{"line_number":4,"context_line":""},{"line_number":5,"context_line":"During the Ocata cycle, the OpenStack-manuals, infra, and translations"},{"line_number":6,"context_line":"team worked together to enable the generation of PDF doc files from"},{"line_number":7,"context_line":"rst-based guide documents. This change provided PDF download URLs to"},{"line_number":8,"context_line":"each HTML document, allowing users who want to see documents offline"},{"line_number":9,"context_line":"the ability to do so."},{"line_number":10,"context_line":""},{"line_number":11,"context_line":"The work was completed at the end of the Ocata release, but was never"}],"source_content_type":"text/x-rst","patch_set":2,"id":"3fce034c_444ab255","line":8,"range":{"start_line":7,"start_character":27,"end_line":8,"end_character":18},"in_reply_to":"3fce034c_fd490832","updated":"2019-04-12 12:38:27.000000000","message":"In the case of the manuals, each \"book\" built from a single Sphinx project is downloadable. For project team docs, I think we want it to work the same way. 1 PDF per Sphinx project. That more or less works out to 1 per repository, except in cases like JD points out below with the deployment guides. I think we should focus on the easy stuff and ignore the API reference for now, since that has a special build process. So in most cases, everything under $repo/doc/source will turn into 1 PDF.","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"989986a691f58aabf66ee0f5fba15f34e25aa6a9","unresolved":false,"context_lines":[{"line_number":4,"context_line":""},{"line_number":5,"context_line":"During the Ocata cycle, the OpenStack-manuals, infra, and translations"},{"line_number":6,"context_line":"team worked together to enable the generation of PDF doc files from"},{"line_number":7,"context_line":"rst-based guide documents. This change provided PDF download URLs to"},{"line_number":8,"context_line":"each HTML document, allowing users who want to see documents offline"},{"line_number":9,"context_line":"the ability to do so."},{"line_number":10,"context_line":""},{"line_number":11,"context_line":"The work was completed at the end of the Ocata release, but was never"}],"source_content_type":"text/x-rst","patch_set":2,"id":"5fc1f717_c33b4ce7","line":8,"range":{"start_line":7,"start_character":27,"end_line":8,"end_character":18},"in_reply_to":"5fc1f717_3b7b678c","updated":"2019-03-27 13:14:17.000000000","message":"To be honest, reading this sentence back to myself I have no idea what I mean. This is terrible. Let me rephrase. o.0","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":17068,"name":"Jean-Philippe Evrard","email":"openstack@a.spamming.party","username":"evrardjp"},"change_message_id":"6e8372ce9d9345278a8e5e63e1f4734961df7a4f","unresolved":false,"context_lines":[{"line_number":4,"context_line":""},{"line_number":5,"context_line":"During the Ocata cycle, the OpenStack-manuals, infra, and translations"},{"line_number":6,"context_line":"team worked together to enable the generation of PDF doc files from"},{"line_number":7,"context_line":"rst-based guide documents. This change provided PDF download URLs to"},{"line_number":8,"context_line":"each HTML document, allowing users who want to see documents offline"},{"line_number":9,"context_line":"the ability to do so."},{"line_number":10,"context_line":""},{"line_number":11,"context_line":"The work was completed at the end of the Ocata release, but was never"}],"source_content_type":"text/x-rst","patch_set":2,"id":"3fce034c_fd490832","line":8,"range":{"start_line":7,"start_character":27,"end_line":8,"end_character":18},"in_reply_to":"5fc1f717_c33b4ce7","updated":"2019-04-11 12:57:19.000000000","message":"Waiting for the rephrasing.","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"ef4bd45fe4c178441eedcbe72302fda087adfb59","unresolved":false,"context_lines":[{"line_number":6,"context_line":"team worked together to enable the generation of PDF doc files from"},{"line_number":7,"context_line":"rst-based guide documents. This change provided PDF download URLs to"},{"line_number":8,"context_line":"each HTML document, allowing users who want to see documents offline"},{"line_number":9,"context_line":"the ability to do so."},{"line_number":10,"context_line":""},{"line_number":11,"context_line":"The work was completed at the end of the Ocata release, but was never"},{"line_number":12,"context_line":"implemented within the project repositories. This means that our users"}],"source_content_type":"text/x-rst","patch_set":2,"id":"5fc1f717_db7b4378","line":9,"updated":"2019-03-26 22:10:40.000000000","message":"Which means they would need to have them all?","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":17068,"name":"Jean-Philippe Evrard","email":"openstack@a.spamming.party","username":"evrardjp"},"change_message_id":"6e8372ce9d9345278a8e5e63e1f4734961df7a4f","unresolved":false,"context_lines":[{"line_number":6,"context_line":"team worked together to enable the generation of PDF doc files from"},{"line_number":7,"context_line":"rst-based guide documents. This change provided PDF download URLs to"},{"line_number":8,"context_line":"each HTML document, allowing users who want to see documents offline"},{"line_number":9,"context_line":"the ability to do so."},{"line_number":10,"context_line":""},{"line_number":11,"context_line":"The work was completed at the end of the Ocata release, but was never"},{"line_number":12,"context_line":"implemented within the project repositories. This means that our users"}],"source_content_type":"text/x-rst","patch_set":2,"id":"3fce034c_fd72687c","line":9,"in_reply_to":"5fc1f717_232c90aa","updated":"2019-04-11 12:57:19.000000000","message":"Does that mean one PDF per guide, or one pdf for ALL the guides? Asking this because deployment guide in OSA is totally separated from all the other guides, which are generated together.","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"989986a691f58aabf66ee0f5fba15f34e25aa6a9","unresolved":false,"context_lines":[{"line_number":6,"context_line":"team worked together to enable the generation of PDF doc files from"},{"line_number":7,"context_line":"rst-based guide documents. This change provided PDF download URLs to"},{"line_number":8,"context_line":"each HTML document, allowing users who want to see documents offline"},{"line_number":9,"context_line":"the ability to do so."},{"line_number":10,"context_line":""},{"line_number":11,"context_line":"The work was completed at the end of the Ocata release, but was never"},{"line_number":12,"context_line":"implemented within the project repositories. This means that our users"}],"source_content_type":"text/x-rst","patch_set":2,"id":"5fc1f717_232c90aa","line":9,"in_reply_to":"5fc1f717_db7b4378","updated":"2019-03-27 13:14:17.000000000","message":"All of the *guides*, yes. I think I\u0027m going to have to clarify this a bit better, sorry Julia.","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"ef4bd45fe4c178441eedcbe72302fda087adfb59","unresolved":false,"context_lines":[{"line_number":11,"context_line":"The work was completed at the end of the Ocata release, but was never"},{"line_number":12,"context_line":"implemented within the project repositories. This means that our users"},{"line_number":13,"context_line":"are only able to download PDF documents for the Installation Guide, the"},{"line_number":14,"context_line":"Contributor Guide, and the Image Guide, limiting the scope for our"},{"line_number":15,"context_line":"offline users."},{"line_number":16,"context_line":""},{"line_number":17,"context_line":"This goal proposes we enable support across the project repositories"},{"line_number":18,"context_line":"to further our goal of being an accessible open source community."}],"source_content_type":"text/x-rst","patch_set":2,"id":"5fc1f717_3bd7e74d","line":15,"range":{"start_line":14,"start_character":40,"end_line":15,"end_character":14},"updated":"2019-03-26 22:10:40.000000000","message":"It might help if we clarify this, because I can kind of see how this might help a user who is forbidden to have internet access in the data center and is at a console trying to install or troubleshoot a component, but I\u0027m worried that we will just further compound the issues of information being up to date or not. Maybe this is only something that should be offered for master branch documentation?","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"989986a691f58aabf66ee0f5fba15f34e25aa6a9","unresolved":false,"context_lines":[{"line_number":11,"context_line":"The work was completed at the end of the Ocata release, but was never"},{"line_number":12,"context_line":"implemented within the project repositories. This means that our users"},{"line_number":13,"context_line":"are only able to download PDF documents for the Installation Guide, the"},{"line_number":14,"context_line":"Contributor Guide, and the Image Guide, limiting the scope for our"},{"line_number":15,"context_line":"offline users."},{"line_number":16,"context_line":""},{"line_number":17,"context_line":"This goal proposes we enable support across the project repositories"},{"line_number":18,"context_line":"to further our goal of being an accessible open source community."}],"source_content_type":"text/x-rst","patch_set":2,"id":"5fc1f717_637858c3","line":15,"range":{"start_line":14,"start_character":40,"end_line":15,"end_character":14},"in_reply_to":"5fc1f717_3bd7e74d","updated":"2019-03-27 13:14:17.000000000","message":"This is a really great point. So, this originally came up for that exact use case, and because of our Chinese contingent and firewall rules that sometimes blocked them from access. \n\nI believe the solution to this was much the same as what we have on the website, but in print. AKA: The PDF would clearly state what release it was from, and a time stamp. This being said, there is also a certain level of onus we need to apply to the user. If the user upgrades, and continues to use Pike documentation for a Stein release stack, that is on the user, not us.\n\nOkay a little off track here, point is, the user still has to clone the repo and build the docs locally for the present solution to work. So we wouldn\u0027t have a PDF link on the site which is never updated. The user has the opportunity to build the latest PDF.","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"15174ca88a8c6d0f578632814d9e831592cc5b15","unresolved":false,"context_lines":[{"line_number":35,"context_line":""},{"line_number":36,"context_line":"The completion criteria for this goal is as follows:"},{"line_number":37,"context_line":""},{"line_number":38,"context_line":"#. Ensure each guide with the `doc/source` tree of the individual project repository is"},{"line_number":39,"context_line":"   able to be successfully built into a PDF document."},{"line_number":40,"context_line":""},{"line_number":41,"context_line":"   This would be determined by ensuring that PDF documents are generated"}],"source_content_type":"text/x-rst","patch_set":2,"id":"5fc1f717_95d91a57","line":38,"range":{"start_line":38,"start_character":10,"end_line":38,"end_character":20},"updated":"2019-03-26 11:39:18.000000000","message":"each guide? doc/source is a single tree, you cannot separate that into several guides","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"c93cfc46cc395a11e8255503e7805b2cdb0ed92c","unresolved":false,"context_lines":[{"line_number":35,"context_line":""},{"line_number":36,"context_line":"The completion criteria for this goal is as follows:"},{"line_number":37,"context_line":""},{"line_number":38,"context_line":"#. Ensure each guide with the `doc/source` tree of the individual project repository is"},{"line_number":39,"context_line":"   able to be successfully built into a PDF document."},{"line_number":40,"context_line":""},{"line_number":41,"context_line":"   This would be determined by ensuring that PDF documents are generated"}],"source_content_type":"text/x-rst","patch_set":2,"id":"3fce034c_64b56e31","line":38,"range":{"start_line":38,"start_character":10,"end_line":38,"end_character":20},"in_reply_to":"3fce034c_9d8ec42c","updated":"2019-04-12 12:38:27.000000000","message":"@Andreas, it is technically possible to tell Sphinx to build several PDFs from one set of input sources. I think we should *not* do that, however, because it will complicate the build process and make linking to the results of the build more difficult.\n\n@Julia, Sphinx will organize the content into chapters automatically based on the entries in the top level toctree directive. I wrote two 1300 page books this way. It works great.","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":17068,"name":"Jean-Philippe Evrard","email":"openstack@a.spamming.party","username":"evrardjp"},"change_message_id":"6e8372ce9d9345278a8e5e63e1f4734961df7a4f","unresolved":false,"context_lines":[{"line_number":35,"context_line":""},{"line_number":36,"context_line":"The completion criteria for this goal is as follows:"},{"line_number":37,"context_line":""},{"line_number":38,"context_line":"#. Ensure each guide with the `doc/source` tree of the individual project repository is"},{"line_number":39,"context_line":"   able to be successfully built into a PDF document."},{"line_number":40,"context_line":""},{"line_number":41,"context_line":"   This would be determined by ensuring that PDF documents are generated"}],"source_content_type":"text/x-rst","patch_set":2,"id":"3fce034c_9d8ec42c","line":38,"range":{"start_line":38,"start_character":10,"end_line":38,"end_character":20},"in_reply_to":"5fc1f717_7b432f40","updated":"2019-04-11 12:57:19.000000000","message":"This is why my comment a little above.","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":13252,"name":"Dr. Jens Harbott","display_name":"Jens Harbott (frickler)","email":"frickler@offenerstapel.de","username":"jrosenboom"},"change_message_id":"2a1c93c3c3c75cc3954a6e4f952e0871d9bb9b6f","unresolved":false,"context_lines":[{"line_number":35,"context_line":""},{"line_number":36,"context_line":"The completion criteria for this goal is as follows:"},{"line_number":37,"context_line":""},{"line_number":38,"context_line":"#. Ensure each guide with the `doc/source` tree of the individual project repository is"},{"line_number":39,"context_line":"   able to be successfully built into a PDF document."},{"line_number":40,"context_line":""},{"line_number":41,"context_line":"   This would be determined by ensuring that PDF documents are generated"}],"source_content_type":"text/x-rst","patch_set":2,"id":"5fc1f717_d89597e5","line":38,"range":{"start_line":38,"start_character":10,"end_line":38,"end_character":20},"in_reply_to":"5fc1f717_95d91a57","updated":"2019-03-26 13:17:54.000000000","message":"In addition to doc/source, there is at least deploy-guide e.g.\n\nhttps://opendev.org/openstack/openstack-ansible/src/branch/master/deploy-guide/source\n\nwhich might deserve getting explicitly mentioned, maybe also api-ref?","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"ef4bd45fe4c178441eedcbe72302fda087adfb59","unresolved":false,"context_lines":[{"line_number":35,"context_line":""},{"line_number":36,"context_line":"The completion criteria for this goal is as follows:"},{"line_number":37,"context_line":""},{"line_number":38,"context_line":"#. Ensure each guide with the `doc/source` tree of the individual project repository is"},{"line_number":39,"context_line":"   able to be successfully built into a PDF document."},{"line_number":40,"context_line":""},{"line_number":41,"context_line":"   This would be determined by ensuring that PDF documents are generated"}],"source_content_type":"text/x-rst","patch_set":2,"id":"5fc1f717_7b432f40","line":38,"range":{"start_line":38,"start_character":10,"end_line":38,"end_character":20},"in_reply_to":"5fc1f717_d89597e5","updated":"2019-03-26 22:10:40.000000000","message":"If we consider /doc/source/admin was intended to be admin guide content, just like /doc/source/contributor was intended to be developer/contributor guide like the original consolidation effort drove, then perhaps each guide is a subset of PDFs but to render an entire tree, with the resulting nested structure of data just seems like we\u0027re going to create huge problems for anyone to actually really make use of a single document.","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":13252,"name":"Dr. Jens Harbott","display_name":"Jens Harbott (frickler)","email":"frickler@offenerstapel.de","username":"jrosenboom"},"change_message_id":"2a1c93c3c3c75cc3954a6e4f952e0871d9bb9b6f","unresolved":false,"context_lines":[{"line_number":43,"context_line":""},{"line_number":44,"context_line":"   .. code-block:: shell"},{"line_number":45,"context_line":""},{"line_number":46,"context_line":"      $ tox -e docs"},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"References"},{"line_number":49,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"}],"source_content_type":"text/x-rst","patch_set":2,"id":"5fc1f717_b8b9ab79","line":46,"updated":"2019-03-26 13:17:54.000000000","message":"Don\u0027t you also want to include publishing those PDF documents somewhere? Or would that be a second step?\n\nBut I also see the risk that this is adding too much weight onto a casual contributor, needing to install all the PDF generation tools for a simple doc update, so I\u0027d probably prefer to make this a dedicated target.","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":17068,"name":"Jean-Philippe Evrard","email":"openstack@a.spamming.party","username":"evrardjp"},"change_message_id":"d360d9d225ca3a3f46c08fd9eab9b8ca3a7926e5","unresolved":false,"context_lines":[{"line_number":43,"context_line":""},{"line_number":44,"context_line":"   .. code-block:: shell"},{"line_number":45,"context_line":""},{"line_number":46,"context_line":"      $ tox -e docs"},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"References"},{"line_number":49,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"}],"source_content_type":"text/x-rst","patch_set":2,"id":"3fce034c_d1c0692d","line":46,"in_reply_to":"3fce034c_243c4692","updated":"2019-04-16 11:42:51.000000000","message":"I sure agree there :)","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"c93cfc46cc395a11e8255503e7805b2cdb0ed92c","unresolved":false,"context_lines":[{"line_number":43,"context_line":""},{"line_number":44,"context_line":"   .. code-block:: shell"},{"line_number":45,"context_line":""},{"line_number":46,"context_line":"      $ tox -e docs"},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"References"},{"line_number":49,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"}],"source_content_type":"text/x-rst","patch_set":2,"id":"3fce034c_243c4692","line":46,"in_reply_to":"3fce034c_bdf2a099","updated":"2019-04-12 12:38:27.000000000","message":"We are potentially going to have to edit every repo\u0027s doc/source/conf.py to make sure the latex settings are present and correct. That seems unavoidable, except in cases where the values are already right. After coming off of the most recent large \"edit the world\" project for the zuul 3 migration, I would STRONGLY encourage you to avoid designing a solution based on lots of fiddly settings like bindep requirements or shell scripts or tox changes that may need to evolve in the future, since that would force you into a situation of editing every repo yet again for each evolution.\n\nFind a way to do this with the smallest number of edits, in the fewest places, that you possibly can.","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"2f5ec91599ff643799e347ea84b3675fc6e64198","unresolved":false,"context_lines":[{"line_number":43,"context_line":""},{"line_number":44,"context_line":"   .. code-block:: shell"},{"line_number":45,"context_line":""},{"line_number":46,"context_line":"      $ tox -e docs"},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"References"},{"line_number":49,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"}],"source_content_type":"text/x-rst","patch_set":2,"id":"5fc1f717_b83d1dbc","line":46,"in_reply_to":"5fc1f717_473c5b2e","updated":"2019-03-26 21:07:40.000000000","message":"+1","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":14482,"name":"Ian Y. Choi","email":"ianyrchoi@gmail.com","username":"ianychoi"},"change_message_id":"fb3987d87a469b302895fbb482305e8ccb8838ec","unresolved":false,"context_lines":[{"line_number":43,"context_line":""},{"line_number":44,"context_line":"   .. code-block:: shell"},{"line_number":45,"context_line":""},{"line_number":46,"context_line":"      $ tox -e docs"},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"References"},{"line_number":49,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"}],"source_content_type":"text/x-rst","patch_set":2,"id":"5fc1f717_f864efba","line":46,"in_reply_to":"5fc1f717_574076a5","updated":"2019-03-27 17:17:20.000000000","message":"https://review.openstack.org/#/c/601659/ is draft proof of concept version - will see how it works..","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"494f9764a4449f618139325c953c5911df0e7814","unresolved":false,"context_lines":[{"line_number":43,"context_line":""},{"line_number":44,"context_line":"   .. code-block:: shell"},{"line_number":45,"context_line":""},{"line_number":46,"context_line":"      $ tox -e docs"},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"References"},{"line_number":49,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"}],"source_content_type":"text/x-rst","patch_set":2,"id":"5fc1f717_473c5b2e","line":46,"in_reply_to":"5fc1f717_67a717be","updated":"2019-03-26 19:01:13.000000000","message":"We could use a shell script that checks whether the main tools like mklatex are installed and then builds PDF - and if it\u0027s not there, just give a message...\n\nNote that we can build PDF directly from sphinx (it uses LaTeX internally)","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"40ec1d82a346eb924264673a0b2957e79c29cff6","unresolved":false,"context_lines":[{"line_number":43,"context_line":""},{"line_number":44,"context_line":"   .. code-block:: shell"},{"line_number":45,"context_line":""},{"line_number":46,"context_line":"      $ tox -e docs"},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"References"},{"line_number":49,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"}],"source_content_type":"text/x-rst","patch_set":2,"id":"5fc1f717_574076a5","line":46,"in_reply_to":"5fc1f717_77ab32d5","updated":"2019-03-27 15:27:11.000000000","message":"I like to avoid magic that happens in the gate and is not reproduceable on developers machines. ;)\n\nBut can be convinced seeing something in action.\n\nRegarding pdfdocs: What should the job do - both if pdfdocs exist and if not?\n\nLet me repeat: Let\u0027s do a proof of concept - and then continue here...","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":15334,"name":"Stephen Finucane","display_name":"stephenfin","email":"stephenfin@redhat.com","username":"sfinucan"},"change_message_id":"a382cf7bac4dbd1be224f2573c1dc14f9acd60b4","unresolved":false,"context_lines":[{"line_number":43,"context_line":""},{"line_number":44,"context_line":"   .. code-block:: shell"},{"line_number":45,"context_line":""},{"line_number":46,"context_line":"      $ tox -e docs"},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"References"},{"line_number":49,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"}],"source_content_type":"text/x-rst","patch_set":2,"id":"5fc1f717_77ab32d5","line":46,"in_reply_to":"5fc1f717_a343a06b","updated":"2019-03-27 15:08:47.000000000","message":"I\u0027d like to try avoid shell scripts as much as possible, personally. Perhaps we could settle on a predefined environment variable that we pass through to tox, which would define the build environment? Something like \u0027OS_DOCS_BUILDER\u003dhtml\u0027.\n\nWe could also just add a \u0027pdfdocs\u0027 tox target to each project?","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":11655,"name":"Julia Kreger","email":"juliaashleykreger@gmail.com","username":"jkreger","status":"Flying to the moon with a Jetpack!"},"change_message_id":"ef4bd45fe4c178441eedcbe72302fda087adfb59","unresolved":false,"context_lines":[{"line_number":43,"context_line":""},{"line_number":44,"context_line":"   .. code-block:: shell"},{"line_number":45,"context_line":""},{"line_number":46,"context_line":"      $ tox -e docs"},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"References"},{"line_number":49,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"}],"source_content_type":"text/x-rst","patch_set":2,"id":"5fc1f717_bb0f572c","line":46,"in_reply_to":"5fc1f717_b83d1dbc","updated":"2019-03-26 22:10:40.000000000","message":"I think Andreas suggestion is reasonable.","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"2bf4fbd35bfa403c6fd2bd7df0bac62cf20f10b8","unresolved":false,"context_lines":[{"line_number":43,"context_line":""},{"line_number":44,"context_line":"   .. code-block:: shell"},{"line_number":45,"context_line":""},{"line_number":46,"context_line":"      $ tox -e docs"},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"References"},{"line_number":49,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"}],"source_content_type":"text/x-rst","patch_set":2,"id":"5fc1f717_67a717be","line":46,"in_reply_to":"5fc1f717_b8b9ab79","updated":"2019-03-26 18:55:32.000000000","message":"Yes, LaTeX is gigantic and can be finicky to install. We don\u0027t want every casual contributor to have to have it.\n\nI think we want to say that we\u0027ll run \"tox -e docs\" to build the HTML, then the job will run some other sphinx commands using that same virtualenv to build the LaTeX input, and then it will run LaTeX to build the PDF. All of those commands should be part of the job, rather than requiring every tox.ini file to be updated to build PDFs.\n\nCan we reuse any of the tooling used to implement this for the openstack-manuals PDF build?\n\nIf we do it this way, with a change in the job, do we need to make changes in each project? Are we going to find documentation that will build for HTML but not PDF? I\u0027ve know that to happen with certain extensions, but I don\u0027t know if we\u0027re using any of those.","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"989986a691f58aabf66ee0f5fba15f34e25aa6a9","unresolved":false,"context_lines":[{"line_number":43,"context_line":""},{"line_number":44,"context_line":"   .. code-block:: shell"},{"line_number":45,"context_line":""},{"line_number":46,"context_line":"      $ tox -e docs"},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"References"},{"line_number":49,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"}],"source_content_type":"text/x-rst","patch_set":2,"id":"5fc1f717_a343a06b","line":46,"in_reply_to":"5fc1f717_bb0f572c","updated":"2019-03-27 13:14:17.000000000","message":"I like that suggestion, thank you Andreas. I can add that to the completion criteria set.","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":17068,"name":"Jean-Philippe Evrard","email":"openstack@a.spamming.party","username":"evrardjp"},"change_message_id":"6e8372ce9d9345278a8e5e63e1f4734961df7a4f","unresolved":false,"context_lines":[{"line_number":43,"context_line":""},{"line_number":44,"context_line":"   .. code-block:: shell"},{"line_number":45,"context_line":""},{"line_number":46,"context_line":"      $ tox -e docs"},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"References"},{"line_number":49,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"}],"source_content_type":"text/x-rst","patch_set":2,"id":"3fce034c_bdf2a099","line":46,"in_reply_to":"5fc1f717_f864efba","updated":"2019-04-11 12:57:19.000000000","message":"I like the approach to test the presence of binary before running said binary. But I also like the fact to not auto build things if not asked.\n\nI would naturally go for a different tox target, but it seems I am the only one in favour for this (even if it means changing all our tox).\n\nHowever, I think the most important is to get this in, so I will not fight here.","commit_id":"2f9781a14c23acfc98cf0d61062dfb65b6dc931b"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"22216aa8d74e5291c4a166c47398b5f89b4a7b34","unresolved":false,"context_lines":[{"line_number":45,"context_line":"The completion criteria for this goal is as follows:"},{"line_number":46,"context_line":""},{"line_number":47,"context_line":"#. Each \"book\" built in a project repository from a single Sphinx project should"},{"line_number":48,"context_line":"   generate a PDF document."},{"line_number":49,"context_line":""},{"line_number":50,"context_line":"   .. note::"},{"line_number":51,"context_line":""}],"source_content_type":"text/x-rst","patch_set":4,"id":"3fce034c_275acff2","line":48,"updated":"2019-04-16 13:27:02.000000000","message":"This is still a bit vague. What about saying something like \"it is possible to run Sphinx using the configuration in doc/source and generate a single PDF file containing all of the documentation in that directory\"?","commit_id":"7514436ee3359f711a0ba66dfd64a0442a5444a6"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"db190a60e729568e80a8c787f3b7048a7ac720be","unresolved":false,"context_lines":[{"line_number":45,"context_line":"The completion criteria for this goal is as follows:"},{"line_number":46,"context_line":""},{"line_number":47,"context_line":"#. Each \"book\" built in a project repository from a single Sphinx project should"},{"line_number":48,"context_line":"   generate a PDF document."},{"line_number":49,"context_line":""},{"line_number":50,"context_line":"   .. note::"},{"line_number":51,"context_line":""}],"source_content_type":"text/x-rst","patch_set":4,"id":"3fce034c_423ee9da","line":48,"in_reply_to":"3fce034c_275acff2","updated":"2019-04-16 14:45:43.000000000","message":"Fair. Will reword.","commit_id":"7514436ee3359f711a0ba66dfd64a0442a5444a6"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"22216aa8d74e5291c4a166c47398b5f89b4a7b34","unresolved":false,"context_lines":[{"line_number":53,"context_line":"      guide to have it\u0027s own sphinx project and build individual PDF documents. But"},{"line_number":54,"context_line":"      that is not in the scope of the  document, just a note for future."},{"line_number":55,"context_line":""},{"line_number":56,"context_line":"#. Each guide is generated with a time and date stamp, including the release name to"},{"line_number":57,"context_line":"   ensure the user is fully aware of the content they have built. It would also be"},{"line_number":58,"context_line":"   helpful to add a disclaimer that this information is updated regularly in the"},{"line_number":59,"context_line":"   project repositories and to check for updates during maintenance periods."}],"source_content_type":"text/x-rst","patch_set":4,"id":"3fce034c_27416f0c","line":56,"updated":"2019-04-16 13:27:02.000000000","message":"A timestamp is going to make it much more difficult to automatically add a link to the downloadable PDF in the HTML version of the docs.\n\nSince each series is going to be published to its own path on the web server, users will be able to find and download the version they want easily, so I think we would be safe in using a consistent name in the build.","commit_id":"7514436ee3359f711a0ba66dfd64a0442a5444a6"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"3739ceb864b91297d5c9b9c585774be130cdc4ae","unresolved":false,"context_lines":[{"line_number":53,"context_line":"      guide to have it\u0027s own sphinx project and build individual PDF documents. But"},{"line_number":54,"context_line":"      that is not in the scope of the  document, just a note for future."},{"line_number":55,"context_line":""},{"line_number":56,"context_line":"#. Each guide is generated with a time and date stamp, including the release name to"},{"line_number":57,"context_line":"   ensure the user is fully aware of the content they have built. It would also be"},{"line_number":58,"context_line":"   helpful to add a disclaimer that this information is updated regularly in the"},{"line_number":59,"context_line":"   project repositories and to check for updates during maintenance periods."}],"source_content_type":"text/x-rst","patch_set":4,"id":"3fce034c_0f9c82be","line":56,"in_reply_to":"3fce034c_0220e1af","updated":"2019-04-16 20:40:41.000000000","message":"I don\u0027t know how any of that works. Does that require that the project teams do anything special?","commit_id":"7514436ee3359f711a0ba66dfd64a0442a5444a6"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"34677fa289a3c798fb6e753f33c0823638d7e5c6","unresolved":false,"context_lines":[{"line_number":53,"context_line":"      guide to have it\u0027s own sphinx project and build individual PDF documents. But"},{"line_number":54,"context_line":"      that is not in the scope of the  document, just a note for future."},{"line_number":55,"context_line":""},{"line_number":56,"context_line":"#. Each guide is generated with a time and date stamp, including the release name to"},{"line_number":57,"context_line":"   ensure the user is fully aware of the content they have built. It would also be"},{"line_number":58,"context_line":"   helpful to add a disclaimer that this information is updated regularly in the"},{"line_number":59,"context_line":"   project repositories and to check for updates during maintenance periods."}],"source_content_type":"text/x-rst","patch_set":4,"id":"3fce034c_aedd2543","line":56,"in_reply_to":"3fce034c_0f9c82be","updated":"2019-04-17 09:12:26.000000000","message":"No, it\u0027s implemented within the theme. I\u0027ll double check but this should be a simple process. It was in the past, at least.","commit_id":"7514436ee3359f711a0ba66dfd64a0442a5444a6"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"db190a60e729568e80a8c787f3b7048a7ac720be","unresolved":false,"context_lines":[{"line_number":53,"context_line":"      guide to have it\u0027s own sphinx project and build individual PDF documents. But"},{"line_number":54,"context_line":"      that is not in the scope of the  document, just a note for future."},{"line_number":55,"context_line":""},{"line_number":56,"context_line":"#. Each guide is generated with a time and date stamp, including the release name to"},{"line_number":57,"context_line":"   ensure the user is fully aware of the content they have built. It would also be"},{"line_number":58,"context_line":"   helpful to add a disclaimer that this information is updated regularly in the"},{"line_number":59,"context_line":"   project repositories and to check for updates during maintenance periods."}],"source_content_type":"text/x-rst","patch_set":4,"id":"3fce034c_0220e1af","line":56,"in_reply_to":"3fce034c_27416f0c","updated":"2019-04-16 14:45:43.000000000","message":"Hm okay, maybe not a timestamp. But at least the release name banner in the background? Like we do for \"draft\" and \"unsupported\" docs. Thoughts?","commit_id":"7514436ee3359f711a0ba66dfd64a0442a5444a6"},{"author":{"_account_id":308,"name":"Thierry Carrez","email":"thierry@openstack.org","username":"ttx"},"change_message_id":"9f9dca3fae28a28a6b124048dc90cdede23b2221","unresolved":false,"context_lines":[{"line_number":53,"context_line":"      guide to have it\u0027s own sphinx project and build individual PDF documents. But"},{"line_number":54,"context_line":"      that is not in the scope of the  document, just a note for future."},{"line_number":55,"context_line":""},{"line_number":56,"context_line":"#. Each guide is generated the release name to ensure the user is fully aware of the"},{"line_number":57,"context_line":"   content they have built. It would also be helpful to add a disclaimer that this"},{"line_number":58,"context_line":"   information is updated regularly in the project repositories and to check for"},{"line_number":59,"context_line":"   updates during maintenance periods."}],"source_content_type":"text/x-rst","patch_set":5,"id":"3fce034c_526be983","line":56,"range":{"start_line":56,"start_character":3,"end_line":56,"end_character":43},"updated":"2019-04-18 09:34:58.000000000","message":"You mean: \"Each guide generated includes the release name\" ?","commit_id":"37d9ee0f087412ed6497446b810bee34f2601a9f"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"340b0205fd66b5cdd258e6723f2401bcb08c3896","unresolved":false,"context_lines":[{"line_number":53,"context_line":"      guide to have it\u0027s own sphinx project and build individual PDF documents. But"},{"line_number":54,"context_line":"      that is not in the scope of the  document, just a note for future."},{"line_number":55,"context_line":""},{"line_number":56,"context_line":"#. Each guide is generated the release name to ensure the user is fully aware of the"},{"line_number":57,"context_line":"   content they have built. It would also be helpful to add a disclaimer that this"},{"line_number":58,"context_line":"   information is updated regularly in the project repositories and to check for"},{"line_number":59,"context_line":"   updates during maintenance periods."}],"source_content_type":"text/x-rst","patch_set":5,"id":"3fce034c_683078e9","line":56,"range":{"start_line":56,"start_character":3,"end_line":56,"end_character":43},"in_reply_to":"3fce034c_526be983","updated":"2019-04-18 11:34:07.000000000","message":"Sigh. Yes. Wow I\u0027m really borking this.","commit_id":"37d9ee0f087412ed6497446b810bee34f2601a9f"},{"author":{"_account_id":11628,"name":"Michael Johnson","email":"johnsomor@gmail.com","username":"johnsom"},"change_message_id":"57070f7bd57753af9d15dcbf7781ac5b90ee2750","unresolved":false,"context_lines":[{"line_number":44,"context_line":""},{"line_number":45,"context_line":"The completion criteria for this goal is as follows:"},{"line_number":46,"context_line":""},{"line_number":47,"context_line":"#. It is possible to run Sphinx using the configuration in `doc/source` and generate a"},{"line_number":48,"context_line":"   single PDF file containing all of the documentation in that directory."},{"line_number":49,"context_line":""},{"line_number":50,"context_line":"   .. note::"}],"source_content_type":"text/x-rst","patch_set":8,"id":"ffb9cba7_e03806a1","line":47,"range":{"start_line":47,"start_character":2,"end_line":47,"end_character":31},"updated":"2019-04-27 00:16:34.000000000","message":"nit: I would argue we should require a tox target for this as well.","commit_id":"e1bb36be35257cd25d112ef5221fefc19d4a35f4"},{"author":{"_account_id":8556,"name":"Ghanshyam Maan","display_name":"Ghanshyam Maan","email":"gmaan.os14@gmail.com","username":"ghanshyam"},"change_message_id":"8f85840d51404b4fd726b22f73e690489c7af59f","unresolved":false,"context_lines":[{"line_number":52,"context_line":"      Publishing multiple PDFs not part of this goal, and should be deferred until"},{"line_number":53,"context_line":"      after this goal is complete."},{"line_number":54,"context_line":""},{"line_number":55,"context_line":"#. Each guide generated includes the release name to ensure the user is fully aware of the"},{"line_number":56,"context_line":"   content they have built. It would also be helpful to add a disclaimer that this"},{"line_number":57,"context_line":"   information is updated regularly in the project repositories and to check for"},{"line_number":58,"context_line":"   updates during maintenance periods."}],"source_content_type":"text/x-rst","patch_set":8,"id":"ffb9cba7_c029749b","line":55,"range":{"start_line":55,"start_character":37,"end_line":55,"end_character":49},"updated":"2019-04-24 17:07:40.000000000","message":"it should be release version not just name as there are always be chance that project backport the fixes with doc update to the stable branch which changes the doc part.","commit_id":"e1bb36be35257cd25d112ef5221fefc19d4a35f4"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"fe4d30fdf6c0df03b7f2ac878fb7d75d4e4d7371","unresolved":false,"context_lines":[{"line_number":52,"context_line":"      Publishing multiple PDFs not part of this goal, and should be deferred until"},{"line_number":53,"context_line":"      after this goal is complete."},{"line_number":54,"context_line":""},{"line_number":55,"context_line":"#. Each guide generated includes the release name to ensure the user is fully aware of the"},{"line_number":56,"context_line":"   content they have built. It would also be helpful to add a disclaimer that this"},{"line_number":57,"context_line":"   information is updated regularly in the project repositories and to check for"},{"line_number":58,"context_line":"   updates during maintenance periods."}],"source_content_type":"text/x-rst","patch_set":8,"id":"ffb9cba7_119355a5","line":55,"range":{"start_line":55,"start_character":37,"end_line":55,"end_character":49},"in_reply_to":"ffb9cba7_5ad24f5e","updated":"2019-04-25 08:58:36.000000000","message":"Good suggestion, thanks Ghanshyam :) i\u0027ll ensure this is followed-up.","commit_id":"e1bb36be35257cd25d112ef5221fefc19d4a35f4"},{"author":{"_account_id":8556,"name":"Ghanshyam Maan","display_name":"Ghanshyam Maan","email":"gmaan.os14@gmail.com","username":"ghanshyam"},"change_message_id":"f813418acccc1cb70d02bb5e45c2fb5fc8bddebe","unresolved":false,"context_lines":[{"line_number":52,"context_line":"      Publishing multiple PDFs not part of this goal, and should be deferred until"},{"line_number":53,"context_line":"      after this goal is complete."},{"line_number":54,"context_line":""},{"line_number":55,"context_line":"#. Each guide generated includes the release name to ensure the user is fully aware of the"},{"line_number":56,"context_line":"   content they have built. It would also be helpful to add a disclaimer that this"},{"line_number":57,"context_line":"   information is updated regularly in the project repositories and to check for"},{"line_number":58,"context_line":"   updates during maintenance periods."}],"source_content_type":"text/x-rst","patch_set":8,"id":"ffb9cba7_5ad24f5e","line":55,"range":{"start_line":55,"start_character":37,"end_line":55,"end_character":49},"in_reply_to":"ffb9cba7_af022b0a","updated":"2019-04-24 20:36:23.000000000","message":"sure, follow up wfm","commit_id":"e1bb36be35257cd25d112ef5221fefc19d4a35f4"},{"author":{"_account_id":1004,"name":"Mohammed Naser","email":"mnaser@vexxhost.com","username":"mnaser"},"change_message_id":"cfb6c98906e4ecfe4406e46041081bf5bea37ed3","unresolved":false,"context_lines":[{"line_number":52,"context_line":"      Publishing multiple PDFs not part of this goal, and should be deferred until"},{"line_number":53,"context_line":"      after this goal is complete."},{"line_number":54,"context_line":""},{"line_number":55,"context_line":"#. Each guide generated includes the release name to ensure the user is fully aware of the"},{"line_number":56,"context_line":"   content they have built. It would also be helpful to add a disclaimer that this"},{"line_number":57,"context_line":"   information is updated regularly in the project repositories and to check for"},{"line_number":58,"context_line":"   updates during maintenance periods."}],"source_content_type":"text/x-rst","patch_set":8,"id":"ffb9cba7_af022b0a","line":55,"range":{"start_line":55,"start_character":37,"end_line":55,"end_character":49},"in_reply_to":"ffb9cba7_c029749b","updated":"2019-04-24 20:26:51.000000000","message":"I\u0027d like to suggest that we make this modification in a follow-up, documentation change fix, in order to be able to land this in time for the PTG.","commit_id":"e1bb36be35257cd25d112ef5221fefc19d4a35f4"}]}