)]}'
{"reference/project-testing-interface.rst":[{"author":{"_account_id":11904,"name":"Sean McGinnis","email":"sean.mcginnis@gmail.com","username":"SeanM"},"change_message_id":"783d89d6b0b6be0f5edadd315cf44da1e57281ad","unresolved":false,"context_lines":[{"line_number":8,"context_line":"consistent testing infrastructure very difficult to deal with. Additionally,"},{"line_number":9,"context_line":"because of the high volume of development changes and testing, the testing"},{"line_number":10,"context_line":"infrastructure has to be able to pre-cache artifacts that are normally fetched"},{"line_number":11,"context_line":"over the Internet. To that end, each project should support a consistent"},{"line_number":12,"context_line":"interface for driving tests and other necessary tasks."},{"line_number":13,"context_line":""},{"line_number":14,"context_line":"The following tasks are required for every project. Every project must:"}],"source_content_type":"text/x-rst","patch_set":1,"id":"5f7c97a3_bb485d2e","line":11,"range":{"start_line":11,"start_character":9,"end_line":11,"end_character":17},"updated":"2018-06-05 20:57:38.000000000","message":"https://www.nytimes.com/2016/06/02/insider/now-it-is-official-the-internet-is-over.html","commit_id":"eae91c110fed5f28db430e1295eeacf81ea1f792"},{"author":{"_account_id":14482,"name":"Ian Y. Choi","email":"ianyrchoi@gmail.com","username":"ianychoi"},"change_message_id":"4d1ed71f3dbacbf94a4f5c6d8d2a49c8ebdac7d3","unresolved":false,"context_lines":[{"line_number":8,"context_line":"consistent testing infrastructure very difficult to deal with. Additionally,"},{"line_number":9,"context_line":"because of the high volume of development changes and testing, the testing"},{"line_number":10,"context_line":"infrastructure has to be able to pre-cache artifacts that are normally fetched"},{"line_number":11,"context_line":"over the Internet. To that end, each project should support a consistent"},{"line_number":12,"context_line":"interface for driving tests and other necessary tasks."},{"line_number":13,"context_line":""},{"line_number":14,"context_line":"The following tasks are required for every project. Every project must:"}],"source_content_type":"text/x-rst","patch_set":1,"id":"5f7c97a3_44bfe1cf","line":11,"range":{"start_line":11,"start_character":9,"end_line":11,"end_character":17},"in_reply_to":"5f7c97a3_bb485d2e","updated":"2018-06-06 05:25:18.000000000","message":"Oh I am learning a new style - thanks a lot!","commit_id":"eae91c110fed5f28db430e1295eeacf81ea1f792"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"6d8dfbb1ab8e8e14440a16144d4639d035ff5437","unresolved":false,"context_lines":[{"line_number":69,"context_line":"  sphinx-build -b html doc/source doc/build"},{"line_number":70,"context_line":""},{"line_number":71,"context_line":"To support documentation translations processing, documentation projects"},{"line_number":72,"context_line":"should locate pot and po files on ``doc/source/locale`` folder and"},{"line_number":73,"context_line":"``doc/source/locale/$lang/LC_MESSAGES`` folder where $lang is ISO Language"},{"line_number":74,"context_line":"code managed by I18n team. For pot file manipulations, projects should"},{"line_number":75,"context_line":"make ``tools/doc-pot-filter.sh`` and describe how the projects manipulate"}],"source_content_type":"text/x-rst","patch_set":2,"id":"5f7c97a3_06c32859","line":72,"range":{"start_line":72,"start_character":18,"end_line":72,"end_character":24},"updated":"2018-06-06 11:45:23.000000000","message":"remove \"and po\" - we should _never_ store po files in git.\n\npo files are generated from pot, no need to have them.","commit_id":"5fcc05ba42d8dd0fa4368a1a00b62417c9b6a7d7"},{"author":{"_account_id":14482,"name":"Ian Y. Choi","email":"ianyrchoi@gmail.com","username":"ianychoi"},"change_message_id":"9b2e082ad79edfd2b6ffbe7ac2f3df896e6ee088","unresolved":false,"context_lines":[{"line_number":69,"context_line":"  sphinx-build -b html doc/source doc/build"},{"line_number":70,"context_line":""},{"line_number":71,"context_line":"To support documentation translations processing, documentation projects"},{"line_number":72,"context_line":"should locate pot and po files on ``doc/source/locale`` folder and"},{"line_number":73,"context_line":"``doc/source/locale/$lang/LC_MESSAGES`` folder where $lang is ISO Language"},{"line_number":74,"context_line":"code managed by I18n team. For pot file manipulations, projects should"},{"line_number":75,"context_line":"make ``tools/doc-pot-filter.sh`` and describe how the projects manipulate"}],"source_content_type":"text/x-rst","patch_set":2,"id":"5f7c97a3_aaca124c","line":72,"range":{"start_line":72,"start_character":18,"end_line":72,"end_character":24},"in_reply_to":"5f7c97a3_06c32859","updated":"2018-06-07 15:18:22.000000000","message":"I have a question on it. po files are stored to git by \"Imported Translations from Zanata\" patches (e.g., [1]) from infrastructure. Maybe is this the reason of no mention on po? Or do you mean that pot files are not managed by git and stored in [2]?\n\n[1] http://git.openstack.org/cgit/openstack/i18n/tree/doc/source/locale/de/LC_MESSAGES/doc.po\n[2] http://tarballs.openstack.org/translation-source/","commit_id":"5fcc05ba42d8dd0fa4368a1a00b62417c9b6a7d7"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"c8d176c2da2777662df94461f4f0d1fcc5088da3","unresolved":false,"context_lines":[{"line_number":71,"context_line":"To support documentation translations processing, documentation projects"},{"line_number":72,"context_line":"should locate po files on ``doc/source/locale/$lang/LC_MESSAGES`` folder where"},{"line_number":73,"context_line":"$lang is ISO Language code managed by I18n team. The project infrastructure"},{"line_number":74,"context_line":"periodically generates pot files which are translation sources of"},{"line_number":75,"context_line":"`translation platform \u003chttps://translate.openstack.org\u003e`_. For pot file"},{"line_number":76,"context_line":"manipulations, projects should make ``tools/doc-pot-filter.sh`` and describe"},{"line_number":77,"context_line":"how the projects manipulate pot file(s)."}],"source_content_type":"text/x-rst","patch_set":3,"id":"5f7c97a3_eea563b6","line":74,"range":{"start_line":74,"start_character":23,"end_line":74,"end_character":26},"updated":"2018-06-08 16:05:17.000000000","message":"po files are generated and are the translation source that comes from zanata. pot is just an intermediate form generate from it.","commit_id":"016396bc5afabade47f519823db91b53dc7e365f"},{"author":{"_account_id":14482,"name":"Ian Y. Choi","email":"ianyrchoi@gmail.com","username":"ianychoi"},"change_message_id":"30cd8b45233548a17c0cc3eff37c673708ee3d51","unresolved":false,"context_lines":[{"line_number":71,"context_line":"To support documentation translations processing, documentation projects"},{"line_number":72,"context_line":"should locate po files on ``doc/source/locale/$lang/LC_MESSAGES`` folder where"},{"line_number":73,"context_line":"$lang is ISO Language code managed by I18n team. The project infrastructure"},{"line_number":74,"context_line":"periodically generates pot files which are translation sources of"},{"line_number":75,"context_line":"`translation platform \u003chttps://translate.openstack.org\u003e`_. For pot file"},{"line_number":76,"context_line":"manipulations, projects should make ``tools/doc-pot-filter.sh`` and describe"},{"line_number":77,"context_line":"how the projects manipulate pot file(s)."}],"source_content_type":"text/x-rst","patch_set":3,"id":"5f7c97a3_2ea4bb4a","line":74,"range":{"start_line":74,"start_character":23,"end_line":74,"end_character":26},"in_reply_to":"5f7c97a3_eea563b6","updated":"2018-06-08 16:29:58.000000000","message":"I agree with you on the perspective of this document.","commit_id":"016396bc5afabade47f519823db91b53dc7e365f"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"c8d176c2da2777662df94461f4f0d1fcc5088da3","unresolved":false,"context_lines":[{"line_number":72,"context_line":"should locate po files on ``doc/source/locale/$lang/LC_MESSAGES`` folder where"},{"line_number":73,"context_line":"$lang is ISO Language code managed by I18n team. The project infrastructure"},{"line_number":74,"context_line":"periodically generates pot files which are translation sources of"},{"line_number":75,"context_line":"`translation platform \u003chttps://translate.openstack.org\u003e`_. For pot file"},{"line_number":76,"context_line":"manipulations, projects should make ``tools/doc-pot-filter.sh`` and describe"},{"line_number":77,"context_line":"how the projects manipulate pot file(s)."},{"line_number":78,"context_line":""},{"line_number":79,"context_line":"To support PDF documentation generation, the following command should work"},{"line_number":80,"context_line":"with ``xelatex`` environment and should result in a PDF file in ``doc/pdf``."}],"source_content_type":"text/x-rst","patch_set":3,"id":"5f7c97a3_0e73ff4f","line":77,"range":{"start_line":75,"start_character":59,"end_line":77,"end_character":40},"updated":"2018-06-08 16:05:17.000000000","message":"I would just remove this here and add it in a different place. This is so specific that I would remove the whole sentence.\n\notherwise, I suggest:\n\n\"If a project needs to manipulate as part of publishing translated documents the generated pot files, this can be done with command ``tools/...`` which is called if available during publishing.","commit_id":"016396bc5afabade47f519823db91b53dc7e365f"},{"author":{"_account_id":14482,"name":"Ian Y. Choi","email":"ianyrchoi@gmail.com","username":"ianychoi"},"change_message_id":"30cd8b45233548a17c0cc3eff37c673708ee3d51","unresolved":false,"context_lines":[{"line_number":72,"context_line":"should locate po files on ``doc/source/locale/$lang/LC_MESSAGES`` folder where"},{"line_number":73,"context_line":"$lang is ISO Language code managed by I18n team. The project infrastructure"},{"line_number":74,"context_line":"periodically generates pot files which are translation sources of"},{"line_number":75,"context_line":"`translation platform \u003chttps://translate.openstack.org\u003e`_. For pot file"},{"line_number":76,"context_line":"manipulations, projects should make ``tools/doc-pot-filter.sh`` and describe"},{"line_number":77,"context_line":"how the projects manipulate pot file(s)."},{"line_number":78,"context_line":""},{"line_number":79,"context_line":"To support PDF documentation generation, the following command should work"},{"line_number":80,"context_line":"with ``xelatex`` environment and should result in a PDF file in ``doc/pdf``."}],"source_content_type":"text/x-rst","patch_set":3,"id":"5f7c97a3_ce62e716","line":77,"range":{"start_line":75,"start_character":59,"end_line":77,"end_character":40},"in_reply_to":"5f7c97a3_0e73ff4f","updated":"2018-06-08 16:29:58.000000000","message":"Thank u - I reflected your suggestion.","commit_id":"016396bc5afabade47f519823db91b53dc7e365f"},{"author":{"_account_id":4257,"name":"Zane Bitter","email":"zbitter@redhat.com","username":"zaneb"},"change_message_id":"21cb53b0ae8f760a0662092b5f20790d398278eb","unresolved":false,"context_lines":[{"line_number":70,"context_line":""},{"line_number":71,"context_line":"To support documentation translations processing, documentation projects"},{"line_number":72,"context_line":"should locate po files on ``doc/source/locale/$lang/LC_MESSAGES`` folder where"},{"line_number":73,"context_line":"$lang is ISO Language code managed by I18n team. If a project needs to"},{"line_number":74,"context_line":"manipulate as part of publishing translated documents the generated pot files,"},{"line_number":75,"context_line":"this can be done with command ``tools/...`` which is called if available"},{"line_number":76,"context_line":"during publishing."},{"line_number":77,"context_line":""}],"source_content_type":"text/x-rst","patch_set":4,"id":"5f7c97a3_3f6f0729","line":74,"range":{"start_line":73,"start_character":62,"end_line":74,"end_character":77},"updated":"2018-06-08 19:55:45.000000000","message":"This isn\u0027t wrong, but I think it would be easier to read if the verb and the object were next to each other:\n\n\"If a project needs, as part of publishing translated documents, to manipulate the generated pot files then this can be done...\"","commit_id":"2395eb58253f63ef251c927b7cd08a03fc18b593"},{"author":{"_account_id":14482,"name":"Ian Y. Choi","email":"ianyrchoi@gmail.com","username":"ianychoi"},"change_message_id":"bc4d7f722d1b9eb73b13f2f7d47e2a3174278cb7","unresolved":false,"context_lines":[{"line_number":70,"context_line":""},{"line_number":71,"context_line":"To support documentation translations processing, documentation projects"},{"line_number":72,"context_line":"should locate po files on ``doc/source/locale/$lang/LC_MESSAGES`` folder where"},{"line_number":73,"context_line":"$lang is ISO Language code managed by I18n team. If a project needs to"},{"line_number":74,"context_line":"manipulate as part of publishing translated documents the generated pot files,"},{"line_number":75,"context_line":"this can be done with command ``tools/...`` which is called if available"},{"line_number":76,"context_line":"during publishing."},{"line_number":77,"context_line":""}],"source_content_type":"text/x-rst","patch_set":4,"id":"5f7c97a3_7dcfabb2","line":74,"range":{"start_line":73,"start_character":62,"end_line":74,"end_character":77},"in_reply_to":"5f7c97a3_3f6f0729","updated":"2018-07-05 13:28:58.000000000","message":"Thanks a lot for the comment! I will reflect your suggestion.","commit_id":"2395eb58253f63ef251c927b7cd08a03fc18b593"},{"author":{"_account_id":14482,"name":"Ian Y. Choi","email":"ianyrchoi@gmail.com","username":"ianychoi"},"change_message_id":"75c722c49b77098ee5c2e1ea24c09a68cb00e9d8","unresolved":false,"context_lines":[{"line_number":70,"context_line":""},{"line_number":71,"context_line":"To support documentation translations processing, documentation projects"},{"line_number":72,"context_line":"should locate po files on ``doc/source/locale/$lang/LC_MESSAGES`` folder where"},{"line_number":73,"context_line":"$lang is ISO Language code managed by I18n team. If a project needs to"},{"line_number":74,"context_line":"manipulate as part of publishing translated documents the generated pot files,"},{"line_number":75,"context_line":"this can be done with command ``tools/...`` which is called if available"},{"line_number":76,"context_line":"during publishing."},{"line_number":77,"context_line":""}],"source_content_type":"text/x-rst","patch_set":4,"id":"5f7c97a3_48a3bdb0","line":74,"range":{"start_line":73,"start_character":62,"end_line":74,"end_character":77},"in_reply_to":"5f7c97a3_7dcfabb2","updated":"2018-08-02 00:39:42.000000000","message":"Done","commit_id":"2395eb58253f63ef251c927b7cd08a03fc18b593"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"4b2df48630e12b26b9845bcec8968127919a951f","unresolved":false,"context_lines":[{"line_number":72,"context_line":"should locate po files on ``doc/source/locale/$lang/LC_MESSAGES`` folder where"},{"line_number":73,"context_line":"$lang is ISO Language code managed by I18n team. If a project needs to"},{"line_number":74,"context_line":"manipulate as part of publishing translated documents the generated pot files,"},{"line_number":75,"context_line":"this can be done with command ``tools/...`` which is called if available"},{"line_number":76,"context_line":"during publishing."},{"line_number":77,"context_line":""},{"line_number":78,"context_line":"To support PDF documentation generation, the following command should work"}],"source_content_type":"text/x-rst","patch_set":4,"id":"5f7c97a3_d93633b5","line":75,"range":{"start_line":75,"start_character":30,"end_line":75,"end_character":43},"updated":"2018-06-08 16:59:47.000000000","message":"Is there a specific tool script supported? I\u0027m not sure how much detail we want to go into here in a governance document, so if there is a lot of flexibility maybe we can link to published documentation for the system?","commit_id":"2395eb58253f63ef251c927b7cd08a03fc18b593"},{"author":{"_account_id":14482,"name":"Ian Y. Choi","email":"ianyrchoi@gmail.com","username":"ianychoi"},"change_message_id":"75c722c49b77098ee5c2e1ea24c09a68cb00e9d8","unresolved":false,"context_lines":[{"line_number":72,"context_line":"should locate po files on ``doc/source/locale/$lang/LC_MESSAGES`` folder where"},{"line_number":73,"context_line":"$lang is ISO Language code managed by I18n team. If a project needs to"},{"line_number":74,"context_line":"manipulate as part of publishing translated documents the generated pot files,"},{"line_number":75,"context_line":"this can be done with command ``tools/...`` which is called if available"},{"line_number":76,"context_line":"during publishing."},{"line_number":77,"context_line":""},{"line_number":78,"context_line":"To support PDF documentation generation, the following command should work"}],"source_content_type":"text/x-rst","patch_set":4,"id":"5f7c97a3_c896ed4a","line":75,"range":{"start_line":75,"start_character":30,"end_line":75,"end_character":43},"in_reply_to":"5f7c97a3_5dcaef9f","updated":"2018-08-02 00:39:42.000000000","message":"I added description on doc-pot-filter.sh.","commit_id":"2395eb58253f63ef251c927b7cd08a03fc18b593"},{"author":{"_account_id":14482,"name":"Ian Y. Choi","email":"ianyrchoi@gmail.com","username":"ianychoi"},"change_message_id":"bc4d7f722d1b9eb73b13f2f7d47e2a3174278cb7","unresolved":false,"context_lines":[{"line_number":72,"context_line":"should locate po files on ``doc/source/locale/$lang/LC_MESSAGES`` folder where"},{"line_number":73,"context_line":"$lang is ISO Language code managed by I18n team. If a project needs to"},{"line_number":74,"context_line":"manipulate as part of publishing translated documents the generated pot files,"},{"line_number":75,"context_line":"this can be done with command ``tools/...`` which is called if available"},{"line_number":76,"context_line":"during publishing."},{"line_number":77,"context_line":""},{"line_number":78,"context_line":"To support PDF documentation generation, the following command should work"}],"source_content_type":"text/x-rst","patch_set":4,"id":"5f7c97a3_5dcaef9f","line":75,"range":{"start_line":75,"start_character":30,"end_line":75,"end_character":43},"in_reply_to":"5f7c97a3_5f944344","updated":"2018-07-05 13:28:58.000000000","message":"Thanks a lot for both suggestions!","commit_id":"2395eb58253f63ef251c927b7cd08a03fc18b593"},{"author":{"_account_id":4257,"name":"Zane Bitter","email":"zbitter@redhat.com","username":"zaneb"},"change_message_id":"21cb53b0ae8f760a0662092b5f20790d398278eb","unresolved":false,"context_lines":[{"line_number":72,"context_line":"should locate po files on ``doc/source/locale/$lang/LC_MESSAGES`` folder where"},{"line_number":73,"context_line":"$lang is ISO Language code managed by I18n team. If a project needs to"},{"line_number":74,"context_line":"manipulate as part of publishing translated documents the generated pot files,"},{"line_number":75,"context_line":"this can be done with command ``tools/...`` which is called if available"},{"line_number":76,"context_line":"during publishing."},{"line_number":77,"context_line":""},{"line_number":78,"context_line":"To support PDF documentation generation, the following command should work"}],"source_content_type":"text/x-rst","patch_set":4,"id":"5f7c97a3_5f944344","line":75,"range":{"start_line":75,"start_character":30,"end_line":75,"end_character":43},"in_reply_to":"5f7c97a3_d93633b5","updated":"2018-06-08 19:55:45.000000000","message":"I think this was a case of copying and pasting from suggested wording in a previous comment without noticing that the actual name of the tool (doc-pot-filter.sh) had been elided.","commit_id":"2395eb58253f63ef251c927b7cd08a03fc18b593"},{"author":{"_account_id":12015,"name":"François Magimel","email":"magimel.francois@gmail.com","username":"linkid"},"change_message_id":"f2b7277caee4c8132cabdf87c1462e1058d41f42","unresolved":false,"context_lines":[{"line_number":76,"context_line":"during publishing."},{"line_number":77,"context_line":""},{"line_number":78,"context_line":"To support PDF documentation generation, the following command should work"},{"line_number":79,"context_line":"with ``xelatex`` environment and should result in a PDF file in ``doc/pdf``."},{"line_number":80,"context_line":""},{"line_number":81,"context_line":".. code-block:: bash"},{"line_number":82,"context_line":""}],"source_content_type":"text/x-rst","patch_set":4,"id":"5f7c97a3_3e01646e","line":79,"range":{"start_line":79,"start_character":66,"end_line":79,"end_character":73},"updated":"2018-07-26 12:35:53.000000000","message":"Wouldn\u0027t it be better to use ``doc/build/pdf`` ?","commit_id":"2395eb58253f63ef251c927b7cd08a03fc18b593"},{"author":{"_account_id":14482,"name":"Ian Y. Choi","email":"ianyrchoi@gmail.com","username":"ianychoi"},"change_message_id":"75c722c49b77098ee5c2e1ea24c09a68cb00e9d8","unresolved":false,"context_lines":[{"line_number":76,"context_line":"during publishing."},{"line_number":77,"context_line":""},{"line_number":78,"context_line":"To support PDF documentation generation, the following command should work"},{"line_number":79,"context_line":"with ``xelatex`` environment and should result in a PDF file in ``doc/pdf``."},{"line_number":80,"context_line":""},{"line_number":81,"context_line":".. code-block:: bash"},{"line_number":82,"context_line":""}],"source_content_type":"text/x-rst","patch_set":4,"id":"5f7c97a3_a88e1123","line":79,"range":{"start_line":79,"start_character":66,"end_line":79,"end_character":73},"in_reply_to":"5f7c97a3_3e01646e","updated":"2018-08-02 00:39:42.000000000","message":"Fixed in https://review.openstack.org/#/c/588110/1/reference/project-testing-interface.rst@94","commit_id":"2395eb58253f63ef251c927b7cd08a03fc18b593"},{"author":{"_account_id":8099,"name":"Graham Hayes","email":"gr@ham.ie","username":"graham"},"change_message_id":"5452cb82f9ac7770be6e22f17793d5af1ba78e99","unresolved":false,"context_lines":[{"line_number":80,"context_line":""},{"line_number":81,"context_line":".. code-block:: bash"},{"line_number":82,"context_line":""},{"line_number":83,"context_line":"  sphinx-build -b latex doc/source doc/pdf"},{"line_number":84,"context_line":"  make -C doc/pdf"},{"line_number":85,"context_line":""},{"line_number":86,"context_line":"Language specific instructions supplement these and are in addition to them."}],"source_content_type":"text/x-rst","patch_set":4,"id":"5f7c97a3_494ffa69","line":83,"updated":"2018-06-18 14:04:19.000000000","message":"This will not work for projects that have written sphinx extensions, and have not added latex writer support.\n\ne.g. - the os-api-ref library does not support outputting latex\n\n    Exception occurred:\n      File \n  \n      \"/Users/hayegr4/repos/github/openstack/designate/.venv/lib/python2.7/site-packages/sphinx/writers/latex.py\", line 2564, in unknown_visit\n        raise NotImplementedError(\u0027Unknown node: \u0027 + node.__class__.__name__)\n    NotImplementedError: Unknown node: rest_expand_all","commit_id":"2395eb58253f63ef251c927b7cd08a03fc18b593"},{"author":{"_account_id":14482,"name":"Ian Y. Choi","email":"ianyrchoi@gmail.com","username":"ianychoi"},"change_message_id":"bc4d7f722d1b9eb73b13f2f7d47e2a3174278cb7","unresolved":false,"context_lines":[{"line_number":80,"context_line":""},{"line_number":81,"context_line":".. code-block:: bash"},{"line_number":82,"context_line":""},{"line_number":83,"context_line":"  sphinx-build -b latex doc/source doc/pdf"},{"line_number":84,"context_line":"  make -C doc/pdf"},{"line_number":85,"context_line":""},{"line_number":86,"context_line":"Language specific instructions supplement these and are in addition to them."}],"source_content_type":"text/x-rst","patch_set":4,"id":"5f7c97a3_7d5d6bea","line":83,"in_reply_to":"5f7c97a3_494ffa69","updated":"2018-07-05 13:28:58.000000000","message":"Oh I have not checked the dependency on os-api-ref. Maybe Docs team can help implement latex support on os-api-ref or can I get some help on how this can be implemented?","commit_id":"2395eb58253f63ef251c927b7cd08a03fc18b593"},{"author":{"_account_id":8099,"name":"Graham Hayes","email":"gr@ham.ie","username":"graham"},"change_message_id":"1b1f32cce3134a812e23b3c0601261b4cf5d879f","unresolved":false,"context_lines":[{"line_number":80,"context_line":""},{"line_number":81,"context_line":".. code-block:: bash"},{"line_number":82,"context_line":""},{"line_number":83,"context_line":"  sphinx-build -b latex doc/source doc/pdf"},{"line_number":84,"context_line":"  make -C doc/pdf"},{"line_number":85,"context_line":""},{"line_number":86,"context_line":"Language specific instructions supplement these and are in addition to them."}],"source_content_type":"text/x-rst","patch_set":4,"id":"5f7c97a3_fc650a1d","line":83,"in_reply_to":"5f7c97a3_7d5d6bea","updated":"2018-07-17 17:10:02.000000000","message":"We would need to write new formatting code for latex and add it here [1].\n\nThere are a few projects that have written custom sphinx tooling, that will be impacted as well (driver matrixes etc)\n\n1 - https://github.com/openstack/os-api-ref/blob/master/os_api_ref/__init__.py#L665-L673","commit_id":"2395eb58253f63ef251c927b7cd08a03fc18b593"},{"author":{"_account_id":14482,"name":"Ian Y. Choi","email":"ianyrchoi@gmail.com","username":"ianychoi"},"change_message_id":"75c722c49b77098ee5c2e1ea24c09a68cb00e9d8","unresolved":false,"context_lines":[{"line_number":80,"context_line":""},{"line_number":81,"context_line":".. code-block:: bash"},{"line_number":82,"context_line":""},{"line_number":83,"context_line":"  sphinx-build -b latex doc/source doc/pdf"},{"line_number":84,"context_line":"  make -C doc/pdf"},{"line_number":85,"context_line":""},{"line_number":86,"context_line":"Language specific instructions supplement these and are in addition to them."}],"source_content_type":"text/x-rst","patch_set":4,"id":"5f7c97a3_88b475d5","line":83,"in_reply_to":"5f7c97a3_fc650a1d","updated":"2018-08-02 00:39:42.000000000","message":"Although the description is not mandatory for all projects including project using os_api_ref, I would like to support PDF builds later by additionally implementing how to work with latex in os_api_ref.","commit_id":"2395eb58253f63ef251c927b7cd08a03fc18b593"},{"author":{"_account_id":15334,"name":"Stephen Finucane","display_name":"stephenfin","email":"stephenfin@redhat.com","username":"sfinucan"},"change_message_id":"523dc2ae5dfb2199d01c500b9451bf2fb6ce4d6b","unresolved":false,"context_lines":[{"line_number":87,"context_line":""},{"line_number":88,"context_line":"If a project needs, as part"},{"line_number":89,"context_line":"of publishing translated documents, to manipulate the generated pot files then"},{"line_number":90,"context_line":"this can be done with command ``tools/...`` which is called if available"},{"line_number":91,"context_line":"during publishing. For example, I18n contributor guide has"},{"line_number":92,"context_line":"`doc-pot-filter.sh \u003chttps://git.openstack.org/cgit/openstack/i18n/tree/tools/doc-pot-filter.sh\u003e`_"},{"line_number":93,"context_line":"which intends not to include csv files in translation targets."}],"source_content_type":"text/x-rst","patch_set":7,"id":"5f7c97a3_9ba4b3a6","line":90,"range":{"start_line":90,"start_character":22,"end_line":90,"end_character":43},"updated":"2018-08-02 14:56:42.000000000","message":"This isn\u0027t a command. I\u0027m not sure what you\u0027re trying to say here. Perhaps \"scripts located in ``tools/``\"?","commit_id":"44b43f85c41edf4ee67135439129c7ab66f26436"},{"author":{"_account_id":14482,"name":"Ian Y. Choi","email":"ianyrchoi@gmail.com","username":"ianychoi"},"change_message_id":"b7fe82c8c4868966c4ab543aa02a3c2d42733b93","unresolved":false,"context_lines":[{"line_number":87,"context_line":""},{"line_number":88,"context_line":"If a project needs, as part"},{"line_number":89,"context_line":"of publishing translated documents, to manipulate the generated pot files then"},{"line_number":90,"context_line":"this can be done with command ``tools/...`` which is called if available"},{"line_number":91,"context_line":"during publishing. For example, I18n contributor guide has"},{"line_number":92,"context_line":"`doc-pot-filter.sh \u003chttps://git.openstack.org/cgit/openstack/i18n/tree/tools/doc-pot-filter.sh\u003e`_"},{"line_number":93,"context_line":"which intends not to include csv files in translation targets."}],"source_content_type":"text/x-rst","patch_set":7,"id":"5f7c97a3_e2e6414a","line":90,"range":{"start_line":90,"start_character":22,"end_line":90,"end_character":43},"in_reply_to":"5f7c97a3_9ba4b3a6","updated":"2018-08-03 11:27:44.000000000","message":"Yeah right - thank u for pointing out this and I modified with proper sentence on the next patch set.","commit_id":"44b43f85c41edf4ee67135439129c7ab66f26436"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"ebce318dcc2dee69dc7ec4313261be835ac7d8e4","unresolved":false,"context_lines":[{"line_number":90,"context_line":"this can be done with scripts located in ``tools/...`` and called if available"},{"line_number":91,"context_line":"during publishing. For example, I18n contributor guide has"},{"line_number":92,"context_line":"`doc-pot-filter.sh \u003chttps://git.openstack.org/cgit/openstack/i18n/tree/tools/doc-pot-filter.sh\u003e`_"},{"line_number":93,"context_line":"which intends not to include csv files in translation targets."},{"line_number":94,"context_line":""},{"line_number":95,"context_line":"Language specific instructions supplement these and are in addition to"},{"line_number":96,"context_line":"them."}],"source_content_type":"text/x-rst","patch_set":8,"id":"5f7c97a3_054827b2","line":93,"updated":"2018-08-03 12:54:22.000000000","message":"Some of this feels like details that should go into the project team guide, which a description of how to set up a project to support translating the documentation.\n\nDo project teams need to modify the sphinx configuration to support translation? Or is it enough for them to have the po files in place?","commit_id":"1b0b32ba77ce8cb3e1f5ca83cc56667c1ef8a51a"},{"author":{"_account_id":14482,"name":"Ian Y. Choi","email":"ianyrchoi@gmail.com","username":"ianychoi"},"change_message_id":"e37ea2bd804f166ac0100a48136f5c3bf0d58ff4","unresolved":false,"context_lines":[{"line_number":90,"context_line":"this can be done with scripts located in ``tools/...`` and called if available"},{"line_number":91,"context_line":"during publishing. For example, I18n contributor guide has"},{"line_number":92,"context_line":"`doc-pot-filter.sh \u003chttps://git.openstack.org/cgit/openstack/i18n/tree/tools/doc-pot-filter.sh\u003e`_"},{"line_number":93,"context_line":"which intends not to include csv files in translation targets."},{"line_number":94,"context_line":""},{"line_number":95,"context_line":"Language specific instructions supplement these and are in addition to"},{"line_number":96,"context_line":"them."}],"source_content_type":"text/x-rst","patch_set":8,"id":"5f7c97a3_c020dda0","line":93,"in_reply_to":"5f7c97a3_054827b2","updated":"2018-08-03 13:09:12.000000000","message":"To deal with translation resources (pot \u0026 po files), project teams don\u0027t need to modify the sphinx configuration but need to guarantee that pot \u0026 po files are stored in right folder locations. The scripts in [1] manages the translation resources, and I have thought that additional scripts in ``tools`` in project repos for manipulating translation string targets would be required for some projects by further discussion with translators (For I18n repo, csv files were included as translation targets but removed upon the request from translators).\n\n[1] https://git.openstack.org/cgit/openstack-infra/project-config/tree/roles/prep-zanata/files/\n[2] https://git.openstack.org/cgit/openstack-infra/project-config/tree/roles/prep-zanata/files/common_translation_update.sh#n428\n\nFollowing detail description on project-team-guide would be a nice idea I think which I have not focused on. Maybe proposing a following patch like https://review.openstack.org/#/c/587707/ would be a good idea? Or how about moving L88-93 to project-team-guide to guide project repos?","commit_id":"1b0b32ba77ce8cb3e1f5ca83cc56667c1ef8a51a"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"527cd196c0313d558d31d2e4a37a30a7de459060","unresolved":false,"context_lines":[{"line_number":90,"context_line":"this can be done with scripts located in ``tools/...`` and called if available"},{"line_number":91,"context_line":"during publishing. For example, I18n contributor guide has"},{"line_number":92,"context_line":"`doc-pot-filter.sh \u003chttps://git.openstack.org/cgit/openstack/i18n/tree/tools/doc-pot-filter.sh\u003e`_"},{"line_number":93,"context_line":"which intends not to include csv files in translation targets."},{"line_number":94,"context_line":""},{"line_number":95,"context_line":"Language specific instructions supplement these and are in addition to"},{"line_number":96,"context_line":"them."}],"source_content_type":"text/x-rst","patch_set":8,"id":"5f7c97a3_f6bda3b2","line":93,"in_reply_to":"5f7c97a3_c020dda0","updated":"2018-08-03 14:57:11.000000000","message":"Which job uses the po files when generating the translated documentation?","commit_id":"1b0b32ba77ce8cb3e1f5ca83cc56667c1ef8a51a"},{"author":{"_account_id":14482,"name":"Ian Y. Choi","email":"ianyrchoi@gmail.com","username":"ianychoi"},"change_message_id":"b5381901c98f4d96391e3f0ce530d7854eb4da80","unresolved":false,"context_lines":[{"line_number":90,"context_line":"this can be done with scripts located in ``tools/...`` and called if available"},{"line_number":91,"context_line":"during publishing. For example, I18n contributor guide has"},{"line_number":92,"context_line":"`doc-pot-filter.sh \u003chttps://git.openstack.org/cgit/openstack/i18n/tree/tools/doc-pot-filter.sh\u003e`_"},{"line_number":93,"context_line":"which intends not to include csv files in translation targets."},{"line_number":94,"context_line":""},{"line_number":95,"context_line":"Language specific instructions supplement these and are in addition to"},{"line_number":96,"context_line":"them."}],"source_content_type":"text/x-rst","patch_set":8,"id":"3f79a3b5_3979b5fb","line":93,"in_reply_to":"5f7c97a3_f6bda3b2","updated":"2018-08-07 14:39:12.000000000","message":"openstack-manuals has \"publishlang\": https://git.openstack.org/cgit/openstack/openstack-manuals/tree/tox.ini#n70 , and https://review.openstack.org/#/c/588110/ patch is such job proposal with pdf build job.","commit_id":"1b0b32ba77ce8cb3e1f5ca83cc56667c1ef8a51a"}]}