)]}'
{"specs/queens/pdf-unified-doc-builds.rst":[{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"475df9c00ba687fa045d5b04e1d2f48b5eb5a5a0","unresolved":false,"context_lines":[{"line_number":16,"context_line":"Problem description"},{"line_number":17,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":18,"context_line":""},{"line_number":19,"context_line":"OpenStack RST-sourced documentation uses Sphinx to build HTML documents"},{"line_number":20,"context_line":"and publish them on docs.openstack.org. RST-sourced documents in"},{"line_number":21,"context_line":"openstack-manuals also have PDF versions of the books."},{"line_number":22,"context_line":"It will be helpful if the PDF versions of the books is extended to"}],"source_content_type":"text/x-rst","patch_set":1,"id":"3f4b6375_575d3e45","line":19,"range":{"start_line":19,"start_character":1,"end_line":19,"end_character":36},"updated":"2017-11-02 04:10:42.000000000","message":"explain the scope - is this openstack-manuals, api-site and security-doc only?","commit_id":"25eb66e4cc62f6a50920ccf637a4d93d0bebb50e"},{"author":{"_account_id":14482,"name":"Ian Y. Choi","email":"ianyrchoi@gmail.com","username":"ianychoi"},"change_message_id":"a84e5ed3890d80910ecf5d5b58d0d9e84d80a69d","unresolved":false,"context_lines":[{"line_number":16,"context_line":"Problem description"},{"line_number":17,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":18,"context_line":""},{"line_number":19,"context_line":"OpenStack RST-sourced documentation uses Sphinx to build HTML documents"},{"line_number":20,"context_line":"and publish them on docs.openstack.org. RST-sourced documents in"},{"line_number":21,"context_line":"openstack-manuals also have PDF versions of the books."},{"line_number":22,"context_line":"It will be helpful if the PDF versions of the books is extended to"}],"source_content_type":"text/x-rst","patch_set":1,"id":"1f485f77_16a1e146","line":19,"range":{"start_line":19,"start_character":1,"end_line":19,"end_character":36},"in_reply_to":"3f4b6375_575d3e45","updated":"2017-11-16 15:36:42.000000000","message":"I explained on the 2nd patch - the scope is for project specific documents.","commit_id":"25eb66e4cc62f6a50920ccf637a4d93d0bebb50e"},{"author":{"_account_id":19779,"name":"Chason Chan","display_name":"chenxing","email":"chason.chan@foxmail.com","username":"chenxing"},"change_message_id":"2e77a737137965f0e4485c6b3462360eb76494fd","unresolved":false,"context_lines":[{"line_number":47,"context_line":"* jang0913"},{"line_number":48,"context_line":"* nexusz99"},{"line_number":49,"context_line":"* ianychoi"},{"line_number":50,"context_line":""},{"line_number":51,"context_line":"Work Items"},{"line_number":52,"context_line":"----------"},{"line_number":53,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"3f4b6375_8eade69c","line":50,"updated":"2017-11-02 02:16:01.000000000","message":"I have interest on this work. Can you add me here? :D","commit_id":"25eb66e4cc62f6a50920ccf637a4d93d0bebb50e"},{"author":{"_account_id":14482,"name":"Ian Y. Choi","email":"ianyrchoi@gmail.com","username":"ianychoi"},"change_message_id":"a84e5ed3890d80910ecf5d5b58d0d9e84d80a69d","unresolved":false,"context_lines":[{"line_number":47,"context_line":"* jang0913"},{"line_number":48,"context_line":"* nexusz99"},{"line_number":49,"context_line":"* ianychoi"},{"line_number":50,"context_line":""},{"line_number":51,"context_line":"Work Items"},{"line_number":52,"context_line":"----------"},{"line_number":53,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"1f485f77_d601093a","line":50,"in_reply_to":"3f4b6375_8eade69c","updated":"2017-11-16 15:36:42.000000000","message":"Sure! added :)","commit_id":"25eb66e4cc62f6a50920ccf637a4d93d0bebb50e"},{"author":{"_account_id":20156,"name":"Petr Kovar","email":"pkovar@redhat.com","username":"pmkovar"},"change_message_id":"e074e253169558c5b78e2fc08e36dcf107ea21b4","unresolved":false,"context_lines":[{"line_number":11,"context_line":"https://blueprints.launchpad.net/openstack-manuals/+spec/pdf-unified-doc-builds"},{"line_number":12,"context_line":""},{"line_number":13,"context_line":"Supporting PDF doc files for project-specific OpenStack documents is"},{"line_number":14,"context_line":"helpful for users who want to see the documents offline."},{"line_number":15,"context_line":""},{"line_number":16,"context_line":"Problem description"},{"line_number":17,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"}],"source_content_type":"text/x-rst","patch_set":3,"id":"ff82abbf_88172da4","line":14,"updated":"2017-11-22 13:38:10.000000000","message":"... or who prefer to print the documents.","commit_id":"acf6ec564a79c2563610a5744d951457ad522050"},{"author":{"_account_id":20156,"name":"Petr Kovar","email":"pkovar@redhat.com","username":"pmkovar"},"change_message_id":"e074e253169558c5b78e2fc08e36dcf107ea21b4","unresolved":false,"context_lines":[{"line_number":19,"context_line":"OpenStack RST-sourced documentation uses Sphinx to build HTML documents"},{"line_number":20,"context_line":"and publish them on docs.openstack.org. RST-sourced documents in"},{"line_number":21,"context_line":"openstack-manuals also have PDF versions of the books."},{"line_number":22,"context_line":"It will be helpful if the PDF versions of the books is extended to"},{"line_number":23,"context_line":"all OpenStack project-specific docs."},{"line_number":24,"context_line":""},{"line_number":25,"context_line":"Proposed change"}],"source_content_type":"text/x-rst","patch_set":3,"id":"ff82abbf_687989fa","line":22,"range":{"start_line":22,"start_character":52,"end_line":22,"end_character":54},"updated":"2017-11-22 13:38:10.000000000","message":"are","commit_id":"acf6ec564a79c2563610a5744d951457ad522050"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"13b218512e9accd34c403594508cea065f79657b","unresolved":false,"context_lines":[{"line_number":19,"context_line":"OpenStack RST-sourced documentation uses Sphinx to build HTML documents"},{"line_number":20,"context_line":"and publish them on docs.openstack.org. RST-sourced documents in"},{"line_number":21,"context_line":"openstack-manuals also have PDF versions of the books."},{"line_number":22,"context_line":"It will be helpful if the PDF versions of the books is extended to"},{"line_number":23,"context_line":"all OpenStack project-specific docs."},{"line_number":24,"context_line":""},{"line_number":25,"context_line":"Proposed change"},{"line_number":26,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"}],"source_content_type":"text/x-rst","patch_set":3,"id":"ff82abbf_2eeaa974","line":23,"range":{"start_line":22,"start_character":0,"end_line":23,"end_character":36},"updated":"2017-11-22 14:40:20.000000000","message":"This would be a cross-project effort, as such before we approve this, it needs cross-project discussion.\n\nIt also might change the PTI, so need to update that as well.\n\nPTI: https://governance.openstack.org/tc/reference/project-testing-interface.html#documentation","commit_id":"acf6ec564a79c2563610a5744d951457ad522050"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"13b218512e9accd34c403594508cea065f79657b","unresolved":false,"context_lines":[{"line_number":25,"context_line":"Proposed change"},{"line_number":26,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":27,"context_line":""},{"line_number":28,"context_line":"Add the support of building PDFs into unified doc builds job."},{"line_number":29,"context_line":""},{"line_number":30,"context_line":"Alternatives"},{"line_number":31,"context_line":"------------"}],"source_content_type":"text/x-rst","patch_set":3,"id":"ff82abbf_cef8dd4a","line":28,"range":{"start_line":28,"start_character":0,"end_line":28,"end_character":61},"updated":"2017-11-22 14:40:20.000000000","message":"So, that is a change completely inside infra - not a docs deliverable.","commit_id":"acf6ec564a79c2563610a5744d951457ad522050"},{"author":{"_account_id":2,"name":"Monty Taylor","email":"mordred@inaugust.com","username":"mordred"},"change_message_id":"0fa47c81f683855268223f5f9de76a8a736e0a61","unresolved":false,"context_lines":[{"line_number":25,"context_line":"Proposed change"},{"line_number":26,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":27,"context_line":""},{"line_number":28,"context_line":"Add the support of building PDFs into unified doc builds job."},{"line_number":29,"context_line":""},{"line_number":30,"context_line":"Alternatives"},{"line_number":31,"context_line":"------------"}],"source_content_type":"text/x-rst","patch_set":3,"id":"bf659307_7503dfbf","line":28,"range":{"start_line":28,"start_character":0,"end_line":28,"end_character":61},"in_reply_to":"ff82abbf_cef8dd4a","updated":"2018-04-04 22:19:32.000000000","message":"I think we can (and should) add the support to the jobs, regardless of anything else. I spent a bit of time investigating this today, but need to do just a little more work.","commit_id":"acf6ec564a79c2563610a5744d951457ad522050"},{"author":{"_account_id":20156,"name":"Petr Kovar","email":"pkovar@redhat.com","username":"pmkovar"},"change_message_id":"e074e253169558c5b78e2fc08e36dcf107ea21b4","unresolved":false,"context_lines":[{"line_number":34,"context_line":"  can be an alternative. However, this result will decrease the manageability"},{"line_number":35,"context_line":"  of build scripts in documentation repositories."},{"line_number":36,"context_line":""},{"line_number":37,"context_line":"* Document how users can built PDFs locally but do not publish PDFs."},{"line_number":38,"context_line":""},{"line_number":39,"context_line":"* Leave the guide with current HTML build infrastructure as is."},{"line_number":40,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"ff82abbf_0868fd1e","line":37,"range":{"start_line":37,"start_character":25,"end_line":37,"end_character":30},"updated":"2017-11-22 13:38:10.000000000","message":"build","commit_id":"acf6ec564a79c2563610a5744d951457ad522050"},{"author":{"_account_id":20156,"name":"Petr Kovar","email":"pkovar@redhat.com","username":"pmkovar"},"change_message_id":"e074e253169558c5b78e2fc08e36dcf107ea21b4","unresolved":false,"context_lines":[{"line_number":36,"context_line":""},{"line_number":37,"context_line":"* Document how users can built PDFs locally but do not publish PDFs."},{"line_number":38,"context_line":""},{"line_number":39,"context_line":"* Leave the guide with current HTML build infrastructure as is."},{"line_number":40,"context_line":""},{"line_number":41,"context_line":"Implementation"},{"line_number":42,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"}],"source_content_type":"text/x-rst","patch_set":3,"id":"ff82abbf_8865ed47","line":39,"range":{"start_line":39,"start_character":12,"end_line":39,"end_character":17},"updated":"2017-11-22 13:38:10.000000000","message":"project-specific docs","commit_id":"acf6ec564a79c2563610a5744d951457ad522050"},{"author":{"_account_id":2,"name":"Monty Taylor","email":"mordred@inaugust.com","username":"mordred"},"change_message_id":"0fa47c81f683855268223f5f9de76a8a736e0a61","unresolved":false,"context_lines":[{"line_number":54,"context_line":""},{"line_number":55,"context_line":"* Test Sphinx builder with setup.cfg"},{"line_number":56,"context_line":""},{"line_number":57,"context_line":"    * http://www.sphinx-doc.org/en/stable/setuptools.html#confval-builder"},{"line_number":58,"context_line":""},{"line_number":59,"context_line":"* Applying to PDF support in one official project as an example"},{"line_number":60,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"bf659307_fe1fd96d","line":57,"updated":"2018-04-04 22:19:32.000000000","message":"The sphinx base job supports a variable \"sphinx_builders\" that can be set. That can be used to test that pdf builders will work for a given repo or repos before we make any job updates.\n\nThat said - I believe we\u0027re going to need to set \"latex_engine \u003d \u0027xelatex\u0027\" in conf.py - as well as add some additional depends (the xelatex step is because I tried this earlier today on the zuul repo and hit a unicode issue that xelatex handled just fine)","commit_id":"acf6ec564a79c2563610a5744d951457ad522050"},{"author":{"_account_id":15334,"name":"Stephen Finucane","display_name":"stephenfin","email":"stephenfin@redhat.com","username":"sfinucan"},"change_message_id":"77c2fbf9729aefdc1cb331d56f8274dc469e29fa","unresolved":false,"context_lines":[{"line_number":54,"context_line":""},{"line_number":55,"context_line":"* Test Sphinx builder with setup.cfg"},{"line_number":56,"context_line":""},{"line_number":57,"context_line":"    * http://www.sphinx-doc.org/en/stable/setuptools.html#confval-builder"},{"line_number":58,"context_line":""},{"line_number":59,"context_line":"* Applying to PDF support in one official project as an example"},{"line_number":60,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"bf659307_d03af296","line":57,"in_reply_to":"bf659307_fe1fd96d","updated":"2018-04-05 09:10:05.000000000","message":"This happens automatically now with the latest openstackdocstheme (1.20.0) [1].\n\n[1] https://github.com/openstack/openstackdocstheme/commit/3c8b2a698#diff-8ccb44ebb0911b3d9e0882dec7779fc2R227","commit_id":"acf6ec564a79c2563610a5744d951457ad522050"},{"author":{"_account_id":20156,"name":"Petr Kovar","email":"pkovar@redhat.com","username":"pmkovar"},"change_message_id":"e074e253169558c5b78e2fc08e36dcf107ea21b4","unresolved":false,"context_lines":[{"line_number":56,"context_line":""},{"line_number":57,"context_line":"    * http://www.sphinx-doc.org/en/stable/setuptools.html#confval-builder"},{"line_number":58,"context_line":""},{"line_number":59,"context_line":"* Applying to PDF support in one official project as an example"},{"line_number":60,"context_line":""},{"line_number":61,"context_line":"    * conf.py modification"},{"line_number":62,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"ff82abbf_485fe571","line":59,"range":{"start_line":59,"start_character":2,"end_line":59,"end_character":13},"updated":"2017-11-22 13:38:10.000000000","message":"Implement?","commit_id":"acf6ec564a79c2563610a5744d951457ad522050"},{"author":{"_account_id":2,"name":"Monty Taylor","email":"mordred@inaugust.com","username":"mordred"},"change_message_id":"0fa47c81f683855268223f5f9de76a8a736e0a61","unresolved":false,"context_lines":[{"line_number":62,"context_line":""},{"line_number":63,"context_line":"* Changes on unified doc build scripts"},{"line_number":64,"context_line":""},{"line_number":65,"context_line":"    * Also using latex builder"},{"line_number":66,"context_line":"    * \"make\" command to convert from latex to pdf"},{"line_number":67,"context_line":"    * Finding a pdf file name"},{"line_number":68,"context_line":"    * Copying the pdf file to publish folder"}],"source_content_type":"text/x-rst","patch_set":3,"id":"bf659307_55e01bfb","line":65,"range":{"start_line":65,"start_character":6,"end_line":65,"end_character":30},"updated":"2018-04-04 22:19:32.000000000","message":"I think we\u0027ll need to decide how we want the job to figure out that pdfs should be made. We have a sphinx_builders variable, but if pdfs become a thing we always want to build if the repo can handle it, we might need to think about this a bit more than just asking everyone to set a zuul variable.\n\nWe could potentially just try reading the builders variable from setup.cfg ...","commit_id":"acf6ec564a79c2563610a5744d951457ad522050"},{"author":{"_account_id":15334,"name":"Stephen Finucane","display_name":"stephenfin","email":"stephenfin@redhat.com","username":"sfinucan"},"change_message_id":"77c2fbf9729aefdc1cb331d56f8274dc469e29fa","unresolved":false,"context_lines":[{"line_number":62,"context_line":""},{"line_number":63,"context_line":"* Changes on unified doc build scripts"},{"line_number":64,"context_line":""},{"line_number":65,"context_line":"    * Also using latex builder"},{"line_number":66,"context_line":"    * \"make\" command to convert from latex to pdf"},{"line_number":67,"context_line":"    * Finding a pdf file name"},{"line_number":68,"context_line":"    * Copying the pdf file to publish folder"}],"source_content_type":"text/x-rst","patch_set":3,"id":"bf659307_30ad6eea","line":65,"range":{"start_line":65,"start_character":6,"end_line":65,"end_character":30},"in_reply_to":"bf659307_55e01bfb","updated":"2018-04-05 09:10:05.000000000","message":"\u003e We could potentially just try reading the builders variable from\n \u003e setup.cfg ...\n\nExcept we\u0027re hoping to get rid of that entire section from \u0027setup.cfg\u0027. Couldn\u0027t we set a flag in the project config? We do that already to say if the project has an API guide or not.","commit_id":"acf6ec564a79c2563610a5744d951457ad522050"},{"author":{"_account_id":20156,"name":"Petr Kovar","email":"pkovar@redhat.com","username":"pmkovar"},"change_message_id":"e074e253169558c5b78e2fc08e36dcf107ea21b4","unresolved":false,"context_lines":[{"line_number":82,"context_line":"    * OpenStack logo display on title page"},{"line_number":83,"context_line":"      (choosing which logo is appropriate for each deliverable would"},{"line_number":84,"context_line":"      get tedious)"},{"line_number":85,"context_line":"    * Optional: watermark to indicate draft or to which version"},{"line_number":86,"context_line":"      the document applies"},{"line_number":87,"context_line":""},{"line_number":88,"context_line":"Dependencies"}],"source_content_type":"text/x-rst","patch_set":3,"id":"ff82abbf_c8a69554","line":85,"updated":"2017-11-22 13:38:10.000000000","message":"There is an ongoing effort to add badges to all docs pages to indicate the support status of docs.\n\nIt would be nice if support for that feature in the PDF theme could also be implemented (at a later phase if appropriate).","commit_id":"acf6ec564a79c2563610a5744d951457ad522050"}]}