)]}'
{"specs/pike/os-manuals-migration.rst":[{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"bd0fa253160fa29c91fb586e9795d498b74dc602","unresolved":false,"context_lines":[{"line_number":42,"context_line":"run, and cut down on the number of separate sphinx configurations in each"},{"line_number":43,"context_line":"repository."},{"line_number":44,"context_line":""},{"line_number":45,"context_line":"In order for a single doc build job to work and make it easy to include links"},{"line_number":46,"context_line":"from the landing pages on docs.openstack.org, we need to ensure a minimum level"},{"line_number":47,"context_line":"of consistency in the organization of the docs directory. The sections are"},{"line_number":48,"context_line":"based on the existing high-level groupings for which there are already landing"}],"source_content_type":"text/x-rst","patch_set":3,"id":"bf091321_54945d8b","line":45,"range":{"start_line":45,"start_character":9,"end_line":45,"end_character":47},"updated":"2017-06-08 19:20:07.000000000","message":"We can probably remove this and just focus on the landing pages \u0026 deep linking. The layout may aid in the transition, because some of it can be scripted, but that\u0027s a secondary concern and there\u0027s no real benefit in terms of the job building the content.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"a15ccfa8cca4f3b6f851509d9554230f26e136d5","unresolved":false,"context_lines":[{"line_number":42,"context_line":"run, and cut down on the number of separate sphinx configurations in each"},{"line_number":43,"context_line":"repository."},{"line_number":44,"context_line":""},{"line_number":45,"context_line":"In order for a single doc build job to work and make it easy to include links"},{"line_number":46,"context_line":"from the landing pages on docs.openstack.org, we need to ensure a minimum level"},{"line_number":47,"context_line":"of consistency in the organization of the docs directory. The sections are"},{"line_number":48,"context_line":"based on the existing high-level groupings for which there are already landing"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_025c6023","line":45,"range":{"start_line":45,"start_character":9,"end_line":45,"end_character":47},"in_reply_to":"bf091321_54945d8b","updated":"2017-06-12 16:05:35.000000000","message":"Done","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":20156,"name":"Petr Kovar","email":"pkovar@redhat.com","username":"pmkovar"},"change_message_id":"f32aa4df44de4ee0e8578b0d040f07cd2127be13","unresolved":false,"context_lines":[{"line_number":47,"context_line":"of consistency in the organization of the docs directory. The sections are"},{"line_number":48,"context_line":"based on the existing high-level groupings for which there are already landing"},{"line_number":49,"context_line":"pages on docs.openstack.org that will need to be updated. Within each"},{"line_number":50,"context_line":"top-level directory, project teams are free to organize their content"},{"line_number":51,"context_line":"however seems most appropriate to them. This is the proposed layout"},{"line_number":52,"context_line":"for phase 1:"},{"line_number":53,"context_line":""},{"line_number":54,"context_line":"* doc/source/"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_ebb720d8","line":51,"range":{"start_line":50,"start_character":21,"end_line":51,"end_character":38},"updated":"2017-06-11 18:02:58.000000000","message":"A purely random organization of project content doesn\u0027t sound like a good idea for the installation tutorial where it is important that individual project guides follow a common template or architecture. If they do not, then maintaining and following the installation documentation might become too difficult.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":20156,"name":"Petr Kovar","email":"pkovar@redhat.com","username":"pmkovar"},"change_message_id":"0290124415e0dfd570cc4a3028df5bb6a056550a","unresolved":false,"context_lines":[{"line_number":47,"context_line":"of consistency in the organization of the docs directory. The sections are"},{"line_number":48,"context_line":"based on the existing high-level groupings for which there are already landing"},{"line_number":49,"context_line":"pages on docs.openstack.org that will need to be updated. Within each"},{"line_number":50,"context_line":"top-level directory, project teams are free to organize their content"},{"line_number":51,"context_line":"however seems most appropriate to them. This is the proposed layout"},{"line_number":52,"context_line":"for phase 1:"},{"line_number":53,"context_line":""},{"line_number":54,"context_line":"* doc/source/"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_f8287f97","line":51,"range":{"start_line":50,"start_character":21,"end_line":51,"end_character":38},"in_reply_to":"7f231b9d_0ed13155","updated":"2017-06-15 20:18:05.000000000","message":"Understood. But the content organization to me also implies that projects can now choose the way installation procedures are developed. Until now, individual installation guides had to follow the configuration from common (and some service-specific) content so that the installation guide would work as a whole. I don\u0027t think we want to lose that.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"cb4983ac3b5ef4db432843a5e9d1e527dfceb622","unresolved":false,"context_lines":[{"line_number":47,"context_line":"of consistency in the organization of the docs directory. The sections are"},{"line_number":48,"context_line":"based on the existing high-level groupings for which there are already landing"},{"line_number":49,"context_line":"pages on docs.openstack.org that will need to be updated. Within each"},{"line_number":50,"context_line":"top-level directory, project teams are free to organize their content"},{"line_number":51,"context_line":"however seems most appropriate to them. This is the proposed layout"},{"line_number":52,"context_line":"for phase 1:"},{"line_number":53,"context_line":""},{"line_number":54,"context_line":"* doc/source/"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_0ed13155","line":51,"range":{"start_line":50,"start_character":21,"end_line":51,"end_character":38},"in_reply_to":"7f231b9d_ebb720d8","updated":"2017-06-12 14:43:57.000000000","message":"I don\u0027t expect \"random\" but I also don\u0027t think it makes sense to prescribe the exact layout. The existing content will be moved over, so I expect it will be maintained in it\u0027s current format/organization.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"c0c23c39780bf546d1c58c303a9a19719a3f36ec","unresolved":false,"context_lines":[{"line_number":47,"context_line":"of consistency in the organization of the docs directory. The sections are"},{"line_number":48,"context_line":"based on the existing high-level groupings for which there are already landing"},{"line_number":49,"context_line":"pages on docs.openstack.org that will need to be updated. Within each"},{"line_number":50,"context_line":"top-level directory, project teams are free to organize their content"},{"line_number":51,"context_line":"however seems most appropriate to them. This is the proposed layout"},{"line_number":52,"context_line":"for phase 1:"},{"line_number":53,"context_line":""},{"line_number":54,"context_line":"* doc/source/"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_928162fe","line":51,"range":{"start_line":50,"start_character":21,"end_line":51,"end_character":38},"in_reply_to":"7f231b9d_f8287f97","updated":"2017-06-15 22:40:51.000000000","message":"We can establish some guidelines, but once the content moves into the project teams\u0027 repositories it\u0027s up to them to follow those guidelines.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":20156,"name":"Petr Kovar","email":"pkovar@redhat.com","username":"pmkovar"},"change_message_id":"f32aa4df44de4ee0e8578b0d040f07cd2127be13","unresolved":false,"context_lines":[{"line_number":58,"context_line":"    (applies to most of the current content under /developer, but not all"},{"line_number":59,"context_line":"    contributors are developers and \"developer\" can be interpreted as"},{"line_number":60,"context_line":"    \"contributor\" and \"user of this library\")"},{"line_number":61,"context_line":"  * configuration/ -- automatically generated (we hope) configuration reference"},{"line_number":62,"context_line":"    information as well as (we further hope) prose explaining what all of those"},{"line_number":63,"context_line":"    options mean and how to use them sensibly"},{"line_number":64,"context_line":"  * cli/ -- anything having to do with using command line tools"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_2b763808","line":61,"range":{"start_line":61,"start_character":4,"end_line":61,"end_character":17},"updated":"2017-06-11 18:02:58.000000000","message":"Sounds a bit too generic. Would configuration-reference be better?","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"cb4983ac3b5ef4db432843a5e9d1e527dfceb622","unresolved":false,"context_lines":[{"line_number":58,"context_line":"    (applies to most of the current content under /developer, but not all"},{"line_number":59,"context_line":"    contributors are developers and \"developer\" can be interpreted as"},{"line_number":60,"context_line":"    \"contributor\" and \"user of this library\")"},{"line_number":61,"context_line":"  * configuration/ -- automatically generated (we hope) configuration reference"},{"line_number":62,"context_line":"    information as well as (we further hope) prose explaining what all of those"},{"line_number":63,"context_line":"    options mean and how to use them sensibly"},{"line_number":64,"context_line":"  * cli/ -- anything having to do with using command line tools"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_6e3785b2","line":61,"range":{"start_line":61,"start_character":4,"end_line":61,"end_character":17},"in_reply_to":"7f231b9d_2b763808","updated":"2017-06-12 14:43:57.000000000","message":"This is the URL, not the document title. I was trying to keep it short.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":20156,"name":"Petr Kovar","email":"pkovar@redhat.com","username":"pmkovar"},"change_message_id":"f32aa4df44de4ee0e8578b0d040f07cd2127be13","unresolved":false,"context_lines":[{"line_number":61,"context_line":"  * configuration/ -- automatically generated (we hope) configuration reference"},{"line_number":62,"context_line":"    information as well as (we further hope) prose explaining what all of those"},{"line_number":63,"context_line":"    options mean and how to use them sensibly"},{"line_number":64,"context_line":"  * cli/ -- anything having to do with using command line tools"},{"line_number":65,"context_line":"  * admin/ -- any admin guide content"},{"line_number":66,"context_line":"  * library/ -- any reference and user information associated with a library"},{"line_number":67,"context_line":"    that is not covered by one of the above categories"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_eb61603b","line":64,"range":{"start_line":64,"start_character":4,"end_line":64,"end_character":7},"updated":"2017-06-11 18:02:58.000000000","message":"cli-reference to make it clearer what the content is about?","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"cb4983ac3b5ef4db432843a5e9d1e527dfceb622","unresolved":false,"context_lines":[{"line_number":61,"context_line":"  * configuration/ -- automatically generated (we hope) configuration reference"},{"line_number":62,"context_line":"    information as well as (we further hope) prose explaining what all of those"},{"line_number":63,"context_line":"    options mean and how to use them sensibly"},{"line_number":64,"context_line":"  * cli/ -- anything having to do with using command line tools"},{"line_number":65,"context_line":"  * admin/ -- any admin guide content"},{"line_number":66,"context_line":"  * library/ -- any reference and user information associated with a library"},{"line_number":67,"context_line":"    that is not covered by one of the above categories"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_2e418d0c","line":64,"range":{"start_line":64,"start_character":4,"end_line":64,"end_character":7},"in_reply_to":"7f231b9d_eb61603b","updated":"2017-06-12 14:43:57.000000000","message":"See above.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":964,"name":"Anne Gentle","email":"annegentle@justwriteclick.com","username":"annegentle"},"change_message_id":"c6504938099b4b75e858545b329c76160a71768f","unresolved":false,"context_lines":[{"line_number":74,"context_line":""},{"line_number":75,"context_line":"* doc/source/"},{"line_number":76,"context_line":""},{"line_number":77,"context_line":"  * api/ -- the REST API reference"},{"line_number":78,"context_line":"  * releasenotes/ -- reno directions (the actual release notes inputs will stay"},{"line_number":79,"context_line":"    in /releasenotes/notes, where they are now)"},{"line_number":80,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_1c284b32","line":77,"updated":"2017-06-12 15:32:40.000000000","message":"This is api-ref today with api-guide as an additional directory for any tutorials and explanatory text.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"1935c8707a9de752a04e9541edbbf4e849bc3b1d","unresolved":false,"context_lines":[{"line_number":74,"context_line":""},{"line_number":75,"context_line":"* doc/source/"},{"line_number":76,"context_line":""},{"line_number":77,"context_line":"  * api/ -- the REST API reference"},{"line_number":78,"context_line":"  * releasenotes/ -- reno directions (the actual release notes inputs will stay"},{"line_number":79,"context_line":"    in /releasenotes/notes, where they are now)"},{"line_number":80,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_f7e12800","line":77,"in_reply_to":"7f231b9d_1c284b32","updated":"2017-06-12 15:54:16.000000000","message":"Ah, OK, I didn\u0027t realize there were 2 separate things. How does one reach the published api-guide content? Does it make sense to combine them into one directory here?","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"742e3554c89d1aaa08abd3b6b28f341f0606653e","unresolved":false,"context_lines":[{"line_number":78,"context_line":"  * releasenotes/ -- reno directions (the actual release notes inputs will stay"},{"line_number":79,"context_line":"    in /releasenotes/notes, where they are now)"},{"line_number":80,"context_line":""},{"line_number":81,"context_line":"A new documentation build job will be set up to take the output produced from"},{"line_number":82,"context_line":"``tox -e venv -- python setup.py build_sphinx`` (matching the existing"},{"line_number":83,"context_line":"`Consistent Testing Interface\""},{"line_number":84,"context_line":"\u003chttps://governance.openstack.org/tc/reference/project-testing-interface.html\u003e`_)"}],"source_content_type":"text/x-rst","patch_set":3,"id":"bf091321_69c9d176","line":81,"updated":"2017-06-08 17:19:35.000000000","message":"See https://review.openstack.org/#/c/471881/ for that build job definition. We\u0027ll add the link to the spec when we spin a new version to respond to other comments.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"a15ccfa8cca4f3b6f851509d9554230f26e136d5","unresolved":false,"context_lines":[{"line_number":78,"context_line":"  * releasenotes/ -- reno directions (the actual release notes inputs will stay"},{"line_number":79,"context_line":"    in /releasenotes/notes, where they are now)"},{"line_number":80,"context_line":""},{"line_number":81,"context_line":"A new documentation build job will be set up to take the output produced from"},{"line_number":82,"context_line":"``tox -e venv -- python setup.py build_sphinx`` (matching the existing"},{"line_number":83,"context_line":"`Consistent Testing Interface\""},{"line_number":84,"context_line":"\u003chttps://governance.openstack.org/tc/reference/project-testing-interface.html\u003e`_)"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_c23d48bc","line":81,"in_reply_to":"bf091321_69c9d176","updated":"2017-06-12 16:05:35.000000000","message":"Done","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":9562,"name":"Ildiko Vancsa","email":"ildiko.vancsa@gmail.com","username":"ildikov"},"change_message_id":"b93b7c1c48d541ac4693fa13d00d4dfd52d25461","unresolved":false,"context_lines":[{"line_number":99,"context_line":"Ultimately, this changes the way we publish results, and redirects will be"},{"line_number":100,"context_line":"required to be setup from all of the existing locations to the new locations,"},{"line_number":101,"context_line":"and move all of the existing documentation under the new structure. We will"},{"line_number":102,"context_line":"retain landing pages for the high level categories such as the install guides,"},{"line_number":103,"context_line":"the configuration reference, and contributor documentation. Those pages will"},{"line_number":104,"context_line":"continue to be mainted by the documentation team, and will deep-link into"},{"line_number":105,"context_line":"the project team documentation."},{"line_number":106,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"bf091321_54cd7d5b","line":103,"range":{"start_line":102,"start_character":63,"end_line":103,"end_character":58},"updated":"2017-06-08 19:37:54.000000000","message":"Do I understand it right that this means that these guides will keep their current structure as one document per guide as opposed to being available as parts under the project pages?","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"52b9e3dd171ddee6350fe906a1fdd907f8662ee7","unresolved":false,"context_lines":[{"line_number":99,"context_line":"Ultimately, this changes the way we publish results, and redirects will be"},{"line_number":100,"context_line":"required to be setup from all of the existing locations to the new locations,"},{"line_number":101,"context_line":"and move all of the existing documentation under the new structure. We will"},{"line_number":102,"context_line":"retain landing pages for the high level categories such as the install guides,"},{"line_number":103,"context_line":"the configuration reference, and contributor documentation. Those pages will"},{"line_number":104,"context_line":"continue to be mainted by the documentation team, and will deep-link into"},{"line_number":105,"context_line":"the project team documentation."},{"line_number":106,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"bf091321_ef095edd","line":103,"range":{"start_line":102,"start_character":63,"end_line":103,"end_character":58},"in_reply_to":"bf091321_54cd7d5b","updated":"2017-06-08 20:00:46.000000000","message":"Not quite.\n\nWe will keep pages like https://docs.openstack.org/project-install-guide/ocata/ but they will just link to URLs like https://docs.openstack.org/nova/ocata/install, which will be part of the single doc build for nova.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":20156,"name":"Petr Kovar","email":"pkovar@redhat.com","username":"pmkovar"},"change_message_id":"f32aa4df44de4ee0e8578b0d040f07cd2127be13","unresolved":false,"context_lines":[{"line_number":113,"context_line":"    tree."},{"line_number":114,"context_line":"  * The chapters not directly related to specific OpenStack projects, such as"},{"line_number":115,"context_line":"    the parts related to installing ntp and RabbitMQ, will be retained in"},{"line_number":116,"context_line":"    openstack-manuals in a new, pared down, \"Before You Install\" guide."},{"line_number":117,"context_line":"  * The current guide is actually built 3 separate times, to cover 3 separate"},{"line_number":118,"context_line":"    deployment platforms. The new build will not support that, so the migration"},{"line_number":119,"context_line":"    for the installation guide will involve breaking the content up into"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_cbe104d3","line":116,"range":{"start_line":116,"start_character":45,"end_line":116,"end_character":63},"updated":"2017-06-11 18:02:58.000000000","message":"Note that there\u0027s also \"Launch an instance\" and the related subsections (https://docs.openstack.org/ocata/install-guide-rdo/launch-instance.html) which do not really qualify as a before installation activity. I don\u0027t think it is necessary to rename the guide from installation tutorial to something else at all, provided the project guides will continue to follow the common information architecture.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"c0c23c39780bf546d1c58c303a9a19719a3f36ec","unresolved":false,"context_lines":[{"line_number":113,"context_line":"    tree."},{"line_number":114,"context_line":"  * The chapters not directly related to specific OpenStack projects, such as"},{"line_number":115,"context_line":"    the parts related to installing ntp and RabbitMQ, will be retained in"},{"line_number":116,"context_line":"    openstack-manuals in a new, pared down, \"Before You Install\" guide."},{"line_number":117,"context_line":"  * The current guide is actually built 3 separate times, to cover 3 separate"},{"line_number":118,"context_line":"    deployment platforms. The new build will not support that, so the migration"},{"line_number":119,"context_line":"    for the installation guide will involve breaking the content up into"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_9296023e","line":116,"range":{"start_line":116,"start_character":45,"end_line":116,"end_character":63},"in_reply_to":"7f231b9d_1e57a328","updated":"2017-06-15 22:40:51.000000000","message":"Yes, after reviewing that section I think I decided it made more sense to just keep one copy. I don\u0027t think that content was mentioned directly in the spec, just in these comments. Unless I\u0027m missing it?","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":20156,"name":"Petr Kovar","email":"pkovar@redhat.com","username":"pmkovar"},"change_message_id":"6d619ad37ebf2d08e622bd5208e33f732fd60496","unresolved":false,"context_lines":[{"line_number":113,"context_line":"    tree."},{"line_number":114,"context_line":"  * The chapters not directly related to specific OpenStack projects, such as"},{"line_number":115,"context_line":"    the parts related to installing ntp and RabbitMQ, will be retained in"},{"line_number":116,"context_line":"    openstack-manuals in a new, pared down, \"Before You Install\" guide."},{"line_number":117,"context_line":"  * The current guide is actually built 3 separate times, to cover 3 separate"},{"line_number":118,"context_line":"    deployment platforms. The new build will not support that, so the migration"},{"line_number":119,"context_line":"    for the installation guide will involve breaking the content up into"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_ce8ba0c0","line":116,"range":{"start_line":116,"start_character":45,"end_line":116,"end_character":63},"in_reply_to":"7f231b9d_9296023e","updated":"2017-06-16 15:05:21.000000000","message":"Now that we seem to agree this should all be in common content, do we need a Before You Install guide? To me, it seems much better to just go with an installation tutorial, contaning common content for before and after tasks, and pointers to project guides.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"cb4983ac3b5ef4db432843a5e9d1e527dfceb622","unresolved":false,"context_lines":[{"line_number":113,"context_line":"    tree."},{"line_number":114,"context_line":"  * The chapters not directly related to specific OpenStack projects, such as"},{"line_number":115,"context_line":"    the parts related to installing ntp and RabbitMQ, will be retained in"},{"line_number":116,"context_line":"    openstack-manuals in a new, pared down, \"Before You Install\" guide."},{"line_number":117,"context_line":"  * The current guide is actually built 3 separate times, to cover 3 separate"},{"line_number":118,"context_line":"    deployment platforms. The new build will not support that, so the migration"},{"line_number":119,"context_line":"    for the installation guide will involve breaking the content up into"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_ee73957f","line":116,"range":{"start_line":116,"start_character":45,"end_line":116,"end_character":63},"in_reply_to":"7f231b9d_cbe104d3","updated":"2017-06-12 14:43:57.000000000","message":"That section is listed as being moved to the OSC docs.\n\nSee https://etherpad.openstack.org/p/doc-migration-tracking for the full list of what moves where.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"9d7e6805d3505c5450ed60ed512c9afb81081aec","unresolved":false,"context_lines":[{"line_number":113,"context_line":"    tree."},{"line_number":114,"context_line":"  * The chapters not directly related to specific OpenStack projects, such as"},{"line_number":115,"context_line":"    the parts related to installing ntp and RabbitMQ, will be retained in"},{"line_number":116,"context_line":"    openstack-manuals in a new, pared down, \"Before You Install\" guide."},{"line_number":117,"context_line":"  * The current guide is actually built 3 separate times, to cover 3 separate"},{"line_number":118,"context_line":"    deployment platforms. The new build will not support that, so the migration"},{"line_number":119,"context_line":"    for the installation guide will involve breaking the content up into"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_ba53fe6a","line":116,"range":{"start_line":116,"start_character":45,"end_line":116,"end_character":63},"in_reply_to":"7f231b9d_ce8ba0c0","updated":"2017-06-16 16:49:55.000000000","message":"Sure. The docs team should organize that however seems best. I\u0027ll update the spec to include fewer details about proposed changes to that content.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":20156,"name":"Petr Kovar","email":"pkovar@redhat.com","username":"pmkovar"},"change_message_id":"0290124415e0dfd570cc4a3028df5bb6a056550a","unresolved":false,"context_lines":[{"line_number":113,"context_line":"    tree."},{"line_number":114,"context_line":"  * The chapters not directly related to specific OpenStack projects, such as"},{"line_number":115,"context_line":"    the parts related to installing ntp and RabbitMQ, will be retained in"},{"line_number":116,"context_line":"    openstack-manuals in a new, pared down, \"Before You Install\" guide."},{"line_number":117,"context_line":"  * The current guide is actually built 3 separate times, to cover 3 separate"},{"line_number":118,"context_line":"    deployment platforms. The new build will not support that, so the migration"},{"line_number":119,"context_line":"    for the installation guide will involve breaking the content up into"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_1e57a328","line":116,"range":{"start_line":116,"start_character":45,"end_line":116,"end_character":63},"in_reply_to":"7f231b9d_ee73957f","updated":"2017-06-15 20:18:05.000000000","message":"That etherpad seems to have been updated and it now says topics on running instances will stay in the openstack-manuals repo as part of the common content (which they are). I guess you also want to update this spec accordingly, then?","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":20156,"name":"Petr Kovar","email":"pkovar@redhat.com","username":"pmkovar"},"change_message_id":"f32aa4df44de4ee0e8578b0d040f07cd2127be13","unresolved":false,"context_lines":[{"line_number":115,"context_line":"    the parts related to installing ntp and RabbitMQ, will be retained in"},{"line_number":116,"context_line":"    openstack-manuals in a new, pared down, \"Before You Install\" guide."},{"line_number":117,"context_line":"  * The current guide is actually built 3 separate times, to cover 3 separate"},{"line_number":118,"context_line":"    deployment platforms. The new build will not support that, so the migration"},{"line_number":119,"context_line":"    for the installation guide will involve breaking the content up into"},{"line_number":120,"context_line":"    separate pages for each platform (as needed)."},{"line_number":121,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_6bd0b0f8","line":118,"range":{"start_line":118,"start_character":26,"end_line":118,"end_character":56},"updated":"2017-06-11 18:02:58.000000000","message":"Is there a reason to drop it for common content?","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":20156,"name":"Petr Kovar","email":"pkovar@redhat.com","username":"pmkovar"},"change_message_id":"0290124415e0dfd570cc4a3028df5bb6a056550a","unresolved":false,"context_lines":[{"line_number":115,"context_line":"    the parts related to installing ntp and RabbitMQ, will be retained in"},{"line_number":116,"context_line":"    openstack-manuals in a new, pared down, \"Before You Install\" guide."},{"line_number":117,"context_line":"  * The current guide is actually built 3 separate times, to cover 3 separate"},{"line_number":118,"context_line":"    deployment platforms. The new build will not support that, so the migration"},{"line_number":119,"context_line":"    for the installation guide will involve breaking the content up into"},{"line_number":120,"context_line":"    separate pages for each platform (as needed)."},{"line_number":121,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_7e3d77db","line":118,"range":{"start_line":118,"start_character":26,"end_line":118,"end_character":56},"in_reply_to":"7f231b9d_4e0a89d2","updated":"2017-06-15 20:18:05.000000000","message":"Since you have already starting working on it, let\u0027s just drop this thread.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"cb4983ac3b5ef4db432843a5e9d1e527dfceb622","unresolved":false,"context_lines":[{"line_number":115,"context_line":"    the parts related to installing ntp and RabbitMQ, will be retained in"},{"line_number":116,"context_line":"    openstack-manuals in a new, pared down, \"Before You Install\" guide."},{"line_number":117,"context_line":"  * The current guide is actually built 3 separate times, to cover 3 separate"},{"line_number":118,"context_line":"    deployment platforms. The new build will not support that, so the migration"},{"line_number":119,"context_line":"    for the installation guide will involve breaking the content up into"},{"line_number":120,"context_line":"    separate pages for each platform (as needed)."},{"line_number":121,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_4e0a89d2","line":118,"range":{"start_line":118,"start_character":26,"end_line":118,"end_character":56},"in_reply_to":"7f231b9d_6bd0b0f8","updated":"2017-06-12 14:43:57.000000000","message":"Do you think it will be confusing to have different styles in the work produced by the docs team compared to the project teams?","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":20156,"name":"Petr Kovar","email":"pkovar@redhat.com","username":"pmkovar"},"change_message_id":"6d619ad37ebf2d08e622bd5208e33f732fd60496","unresolved":false,"context_lines":[{"line_number":115,"context_line":"    the parts related to installing ntp and RabbitMQ, will be retained in"},{"line_number":116,"context_line":"    openstack-manuals in a new, pared down, \"Before You Install\" guide."},{"line_number":117,"context_line":"  * The current guide is actually built 3 separate times, to cover 3 separate"},{"line_number":118,"context_line":"    deployment platforms. The new build will not support that, so the migration"},{"line_number":119,"context_line":"    for the installation guide will involve breaking the content up into"},{"line_number":120,"context_line":"    separate pages for each platform (as needed)."},{"line_number":121,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_8e9128f4","line":118,"range":{"start_line":118,"start_character":26,"end_line":118,"end_character":56},"in_reply_to":"7f231b9d_7e3d77db","updated":"2017-06-16 15:05:21.000000000","message":"Done","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":5046,"name":"Lance Bragstad","email":"lbragstad@redhat.com","username":"ldbragst"},"change_message_id":"d8d7ceb999574c9983a56e4d36095c3b2c9c3c60","unresolved":false,"context_lines":[{"line_number":117,"context_line":"  * The current guide is actually built 3 separate times, to cover 3 separate"},{"line_number":118,"context_line":"    deployment platforms. The new build will not support that, so the migration"},{"line_number":119,"context_line":"    for the installation guide will involve breaking the content up into"},{"line_number":120,"context_line":"    separate pages for each platform (as needed)."},{"line_number":121,"context_line":""},{"line_number":122,"context_line":"* Project Installation guides, already in tree"},{"line_number":123,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"bf091321_28a197aa","line":120,"updated":"2017-06-08 16:36:09.000000000","message":"To clarify - it sounds like each project team is going to be on the hook for making sure their installation guide is accurate with each platform, correct?","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"742e3554c89d1aaa08abd3b6b28f341f0606653e","unresolved":false,"context_lines":[{"line_number":117,"context_line":"  * The current guide is actually built 3 separate times, to cover 3 separate"},{"line_number":118,"context_line":"    deployment platforms. The new build will not support that, so the migration"},{"line_number":119,"context_line":"    for the installation guide will involve breaking the content up into"},{"line_number":120,"context_line":"    separate pages for each platform (as needed)."},{"line_number":121,"context_line":""},{"line_number":122,"context_line":"* Project Installation guides, already in tree"},{"line_number":123,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"bf091321_c988dd20","line":120,"in_reply_to":"bf091321_28a197aa","updated":"2017-06-08 17:19:35.000000000","message":"That\u0027s the idea, yes.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":20156,"name":"Petr Kovar","email":"pkovar@redhat.com","username":"pmkovar"},"change_message_id":"f32aa4df44de4ee0e8578b0d040f07cd2127be13","unresolved":false,"context_lines":[{"line_number":121,"context_line":""},{"line_number":122,"context_line":"* Project Installation guides, already in tree"},{"line_number":123,"context_line":""},{"line_number":124,"context_line":"  * We recommend any installation guides already in-tree also move to the new"},{"line_number":125,"context_line":"    organization."},{"line_number":126,"context_line":""},{"line_number":127,"context_line":"* Administrator Guide"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_8b042c7d","line":124,"updated":"2017-06-11 18:02:58.000000000","message":"I think we should also talk about following the common architecture here, with the major change being that in-tree guides will move to another directory.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":20156,"name":"Petr Kovar","email":"pkovar@redhat.com","username":"pmkovar"},"change_message_id":"f32aa4df44de4ee0e8578b0d040f07cd2127be13","unresolved":false,"context_lines":[{"line_number":121,"context_line":""},{"line_number":122,"context_line":"* Project Installation guides, already in tree"},{"line_number":123,"context_line":""},{"line_number":124,"context_line":"  * We recommend any installation guides already in-tree also move to the new"},{"line_number":125,"context_line":"    organization."},{"line_number":126,"context_line":""},{"line_number":127,"context_line":"* Administrator Guide"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_cbf4645e","line":124,"range":{"start_line":124,"start_character":7,"end_line":124,"end_character":16},"updated":"2017-06-11 18:02:58.000000000","message":"If we want to be make this new installation guide structure maintainable, then it should really be consistent across all projects, so \"recommend\" here doesn\u0027t sound strong enough.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"cb4983ac3b5ef4db432843a5e9d1e527dfceb622","unresolved":false,"context_lines":[{"line_number":121,"context_line":""},{"line_number":122,"context_line":"* Project Installation guides, already in tree"},{"line_number":123,"context_line":""},{"line_number":124,"context_line":"  * We recommend any installation guides already in-tree also move to the new"},{"line_number":125,"context_line":"    organization."},{"line_number":126,"context_line":""},{"line_number":127,"context_line":"* Administrator Guide"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_8eed41f1","line":124,"range":{"start_line":124,"start_character":7,"end_line":124,"end_character":16},"in_reply_to":"7f231b9d_cbf4645e","updated":"2017-06-12 14:43:57.000000000","message":"It\u0027s a matter of prioritizing and phasing in the work. We have quite a few teams who are already hard-pressed to keep up with the work they have to do because of cuts. Moving the existing docs from a build that already works does not need to be their highest priority.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":5046,"name":"Lance Bragstad","email":"lbragstad@redhat.com","username":"ldbragst"},"change_message_id":"d8d7ceb999574c9983a56e4d36095c3b2c9c3c60","unresolved":false,"context_lines":[{"line_number":127,"context_line":"* Administrator Guide"},{"line_number":128,"context_line":""},{"line_number":129,"context_line":"  * This content will move from openstack-manuals into each project tree. No"},{"line_number":130,"context_line":"    part will be retained in openstack-manuals. This spec was already"},{"line_number":131,"context_line":"    approved:"},{"line_number":132,"context_line":"    https://review.openstack.org/#/c/439122/"},{"line_number":133,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"bf091321_08949336","line":130,"updated":"2017-06-08 16:36:09.000000000","message":"nit: make this a link?","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":20156,"name":"Petr Kovar","email":"pkovar@redhat.com","username":"pmkovar"},"change_message_id":"f32aa4df44de4ee0e8578b0d040f07cd2127be13","unresolved":false,"context_lines":[{"line_number":138,"context_line":""},{"line_number":139,"context_line":"* Operations Guide"},{"line_number":140,"context_line":""},{"line_number":141,"context_line":"  * This guide will eventually move from openstack-manuals into the wiki."},{"line_number":142,"context_line":"    Nothing will be done with it until a volunteer is found to manage that"},{"line_number":143,"context_line":"    move."},{"line_number":144,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_2b4878ca","line":141,"updated":"2017-06-11 18:02:58.000000000","message":"As I said previously, I\u0027d recommend just dropping the content (unpublish it and/or deprecate it). This might be more effective in triggering a volunteer activity.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"cb4983ac3b5ef4db432843a5e9d1e527dfceb622","unresolved":false,"context_lines":[{"line_number":138,"context_line":""},{"line_number":139,"context_line":"* Operations Guide"},{"line_number":140,"context_line":""},{"line_number":141,"context_line":"  * This guide will eventually move from openstack-manuals into the wiki."},{"line_number":142,"context_line":"    Nothing will be done with it until a volunteer is found to manage that"},{"line_number":143,"context_line":"    move."},{"line_number":144,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_2eabcd89","line":141,"in_reply_to":"7f231b9d_2b4878ca","updated":"2017-06-12 14:43:57.000000000","message":"Sure. That felt a bit extreme, and there is a lot of other work to do, so we proposed leaving it alone, for now.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":964,"name":"Anne Gentle","email":"annegentle@justwriteclick.com","username":"annegentle"},"change_message_id":"c6504938099b4b75e858545b329c76160a71768f","unresolved":false,"context_lines":[{"line_number":145,"context_line":"* Security Guide"},{"line_number":146,"context_line":""},{"line_number":147,"context_line":"  * This content will stay in openstack-manuals, and be managed by the"},{"line_number":148,"context_line":"    security team."},{"line_number":149,"context_line":"  * A notice will be added to each page indicating the last time it was"},{"line_number":150,"context_line":"    updated and which release is relevant."},{"line_number":151,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_1cabab89","line":148,"updated":"2017-06-12 15:32:40.000000000","message":"Only thing I\u0027d say about this idea is that it used to be in its own repo, that team has its own repo, so why not move it? That team then makes any decisions about whether to keep it or not instead of adding another decision point for the docs team and PTL? Just thinking aloud after reading the general sentiment of the whole, this particular section doesn\u0027t match necessarily the entire rest of the spec.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"1935c8707a9de752a04e9541edbbf4e849bc3b1d","unresolved":false,"context_lines":[{"line_number":145,"context_line":"* Security Guide"},{"line_number":146,"context_line":""},{"line_number":147,"context_line":"  * This content will stay in openstack-manuals, and be managed by the"},{"line_number":148,"context_line":"    security team."},{"line_number":149,"context_line":"  * A notice will be added to each page indicating the last time it was"},{"line_number":150,"context_line":"    updated and which release is relevant."},{"line_number":151,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_b7917055","line":148,"in_reply_to":"7f231b9d_1cabab89","updated":"2017-06-12 15:54:16.000000000","message":"Alex and the security team worked out this arrangement. I think it\u0027s fine to move it, but the amount of content moving around is already pretty significant, so maybe we can do that separately, since it will be a single bulk export?","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":964,"name":"Anne Gentle","email":"annegentle@justwriteclick.com","username":"annegentle"},"change_message_id":"c6504938099b4b75e858545b329c76160a71768f","unresolved":false,"context_lines":[{"line_number":147,"context_line":"  * This content will stay in openstack-manuals, and be managed by the"},{"line_number":148,"context_line":"    security team."},{"line_number":149,"context_line":"  * A notice will be added to each page indicating the last time it was"},{"line_number":150,"context_line":"    updated and which release is relevant."},{"line_number":151,"context_line":""},{"line_number":152,"context_line":"* Architecture Design Guide"},{"line_number":153,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_5c8fe322","line":150,"updated":"2017-06-12 15:32:40.000000000","message":"I wouldn\u0027t add work in the spec without having people assigned, I wouldn\u0027t prioritize this work over other items mentioned in this spec.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"1935c8707a9de752a04e9541edbbf4e849bc3b1d","unresolved":false,"context_lines":[{"line_number":147,"context_line":"  * This content will stay in openstack-manuals, and be managed by the"},{"line_number":148,"context_line":"    security team."},{"line_number":149,"context_line":"  * A notice will be added to each page indicating the last time it was"},{"line_number":150,"context_line":"    updated and which release is relevant."},{"line_number":151,"context_line":""},{"line_number":152,"context_line":"* Architecture Design Guide"},{"line_number":153,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_b7cdf05e","line":150,"in_reply_to":"7f231b9d_5c8fe322","updated":"2017-06-12 15:54:16.000000000","message":"That\u0027s a good point. https://review.openstack.org/#/c/470059 updates the main page, so I will rephrase this item to say that (instead of every page) and link to that review.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"a15ccfa8cca4f3b6f851509d9554230f26e136d5","unresolved":false,"context_lines":[{"line_number":147,"context_line":"  * This content will stay in openstack-manuals, and be managed by the"},{"line_number":148,"context_line":"    security team."},{"line_number":149,"context_line":"  * A notice will be added to each page indicating the last time it was"},{"line_number":150,"context_line":"    updated and which release is relevant."},{"line_number":151,"context_line":""},{"line_number":152,"context_line":"* Architecture Design Guide"},{"line_number":153,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_22707ca5","line":150,"in_reply_to":"7f231b9d_b7cdf05e","updated":"2017-06-12 16:05:35.000000000","message":"Done","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":964,"name":"Anne Gentle","email":"annegentle@justwriteclick.com","username":"annegentle"},"change_message_id":"c6504938099b4b75e858545b329c76160a71768f","unresolved":false,"context_lines":[{"line_number":172,"context_line":"    https://blueprints.launchpad.net/openstack-manuals/+spec/automate-config-ref"},{"line_number":173,"context_line":""},{"line_number":174,"context_line":"* API Documentation"},{"line_number":175,"context_line":"  * No changes, for now."},{"line_number":176,"context_line":""},{"line_number":177,"context_line":"* End User Guide"},{"line_number":178,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_5c7923fa","line":175,"updated":"2017-06-12 15:32:40.000000000","message":"Why \"for now\" -- doesn\u0027t seem to help with the spirit of the spec which is to get good decisions written down. Remove \"for now\" to avoid any future confusion.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"1935c8707a9de752a04e9541edbbf4e849bc3b1d","unresolved":false,"context_lines":[{"line_number":172,"context_line":"    https://blueprints.launchpad.net/openstack-manuals/+spec/automate-config-ref"},{"line_number":173,"context_line":""},{"line_number":174,"context_line":"* API Documentation"},{"line_number":175,"context_line":"  * No changes, for now."},{"line_number":176,"context_line":""},{"line_number":177,"context_line":"* End User Guide"},{"line_number":178,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_f7392841","line":175,"in_reply_to":"7f231b9d_5c7923fa","updated":"2017-06-12 15:54:16.000000000","message":"FWIW, this refers to https://developer.openstack.org/api-guide/quick-start/","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":964,"name":"Anne Gentle","email":"annegentle@justwriteclick.com","username":"annegentle"},"change_message_id":"c6504938099b4b75e858545b329c76160a71768f","unresolved":false,"context_lines":[{"line_number":177,"context_line":"* End User Guide"},{"line_number":178,"context_line":""},{"line_number":179,"context_line":"  * This content will be divided between the horizon repository and"},{"line_number":180,"context_line":"    python-openstackclient repository."},{"line_number":181,"context_line":""},{"line_number":182,"context_line":"* Command-Line Reference"},{"line_number":183,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_5c624340","line":180,"updated":"2017-06-12 15:32:40.000000000","message":"There\u0027s some shared common content, would that remain in openstack-manuals?","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"1935c8707a9de752a04e9541edbbf4e849bc3b1d","unresolved":false,"context_lines":[{"line_number":177,"context_line":"* End User Guide"},{"line_number":178,"context_line":""},{"line_number":179,"context_line":"  * This content will be divided between the horizon repository and"},{"line_number":180,"context_line":"    python-openstackclient repository."},{"line_number":181,"context_line":""},{"line_number":182,"context_line":"* Command-Line Reference"},{"line_number":183,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_5779fcf9","line":180,"in_reply_to":"7f231b9d_5c624340","updated":"2017-06-12 15:54:16.000000000","message":"See https://etherpad.openstack.org/p/doc-migration-tracking for details.\n\nI think the common content there will already be copied into the common builds (it has the formatting convention info, for example).","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":964,"name":"Anne Gentle","email":"annegentle@justwriteclick.com","username":"annegentle"},"change_message_id":"c6504938099b4b75e858545b329c76160a71768f","unresolved":false,"context_lines":[{"line_number":200,"context_line":"#. Add auto-generated config reference section(s)."},{"line_number":201,"context_line":"#. Update project-config to have the doc build use the new jobs instead of the"},{"line_number":202,"context_line":"   old jobs by replacing \u0027openstack-server-publish-jobs\u0027 with"},{"line_number":203,"context_line":"   \u0027openstack-unified-publish-jobs\u0027."},{"line_number":204,"context_line":"#. After the content and docs jobs for a repo are updated, set up the redirect"},{"line_number":205,"context_line":"   from /developer to the new /contributor location."},{"line_number":206,"context_line":"#. After project-specific install guides are moved into the doc tree, set up"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_1cea8b74","line":203,"updated":"2017-06-12 15:32:40.000000000","message":"Add a statement about the task of ensuring the use of openstackdocstheme here.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"a15ccfa8cca4f3b6f851509d9554230f26e136d5","unresolved":false,"context_lines":[{"line_number":200,"context_line":"#. Add auto-generated config reference section(s)."},{"line_number":201,"context_line":"#. Update project-config to have the doc build use the new jobs instead of the"},{"line_number":202,"context_line":"   old jobs by replacing \u0027openstack-server-publish-jobs\u0027 with"},{"line_number":203,"context_line":"   \u0027openstack-unified-publish-jobs\u0027."},{"line_number":204,"context_line":"#. After the content and docs jobs for a repo are updated, set up the redirect"},{"line_number":205,"context_line":"   from /developer to the new /contributor location."},{"line_number":206,"context_line":"#. After project-specific install guides are moved into the doc tree, set up"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_02758095","line":203,"in_reply_to":"7f231b9d_1cea8b74","updated":"2017-06-12 16:05:35.000000000","message":"Done","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":970,"name":"Dean Troyer","email":"dtroyer@gmail.com","username":"dtroyer"},"change_message_id":"80763b0ae456e72f93f7ccab7014ca331281ca7c","unresolved":false,"context_lines":[{"line_number":232,"context_line":"We did consider using \"service type\" instead of \"project name\" for the"},{"line_number":233,"context_line":"publishing URLs, but not all of the projects that need documentations"},{"line_number":234,"context_line":"are services. We will have user-facing documentation coming from several"},{"line_number":235,"context_line":"Oslo libraries, for example."},{"line_number":236,"context_line":""},{"line_number":237,"context_line":"Implementation"},{"line_number":238,"context_line":"~~~~~~~~~~~~~~"}],"source_content_type":"text/x-rst","patch_set":3,"id":"bf091321_63e450ad","line":235,"updated":"2017-06-08 16:42:40.000000000","message":"Would it make sense to have redirects from service-type for those that do have mappings?  Some projects try very hard to not use project names in user-visible places.\n\nIf we did this, I would suggest only using the canonical names from the service type registry and not the aliases.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"a15ccfa8cca4f3b6f851509d9554230f26e136d5","unresolved":false,"context_lines":[{"line_number":232,"context_line":"We did consider using \"service type\" instead of \"project name\" for the"},{"line_number":233,"context_line":"publishing URLs, but not all of the projects that need documentations"},{"line_number":234,"context_line":"are services. We will have user-facing documentation coming from several"},{"line_number":235,"context_line":"Oslo libraries, for example."},{"line_number":236,"context_line":""},{"line_number":237,"context_line":"Implementation"},{"line_number":238,"context_line":"~~~~~~~~~~~~~~"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_c26668ee","line":235,"in_reply_to":"7f231b9d_1c9f2b04","updated":"2017-06-12 16:05:35.000000000","message":"Done","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":964,"name":"Anne Gentle","email":"annegentle@justwriteclick.com","username":"annegentle"},"change_message_id":"c6504938099b4b75e858545b329c76160a71768f","unresolved":false,"context_lines":[{"line_number":232,"context_line":"We did consider using \"service type\" instead of \"project name\" for the"},{"line_number":233,"context_line":"publishing URLs, but not all of the projects that need documentations"},{"line_number":234,"context_line":"are services. We will have user-facing documentation coming from several"},{"line_number":235,"context_line":"Oslo libraries, for example."},{"line_number":236,"context_line":""},{"line_number":237,"context_line":"Implementation"},{"line_number":238,"context_line":"~~~~~~~~~~~~~~"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7f231b9d_1c9f2b04","line":235,"in_reply_to":"bf091321_09e255d6","updated":"2017-06-12 15:32:40.000000000","message":"Sounds good, can you write it out with some examples for clarity?","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"742e3554c89d1aaa08abd3b6b28f341f0606653e","unresolved":false,"context_lines":[{"line_number":232,"context_line":"We did consider using \"service type\" instead of \"project name\" for the"},{"line_number":233,"context_line":"publishing URLs, but not all of the projects that need documentations"},{"line_number":234,"context_line":"are services. We will have user-facing documentation coming from several"},{"line_number":235,"context_line":"Oslo libraries, for example."},{"line_number":236,"context_line":""},{"line_number":237,"context_line":"Implementation"},{"line_number":238,"context_line":"~~~~~~~~~~~~~~"}],"source_content_type":"text/x-rst","patch_set":3,"id":"bf091321_09e255d6","line":235,"in_reply_to":"bf091321_63e450ad","updated":"2017-06-08 17:19:35.000000000","message":"I like that as a compromise.","commit_id":"60ea49428bddf65bbdda0c96c923034efbe54e09"},{"author":{"_account_id":4257,"name":"Zane Bitter","email":"zbitter@redhat.com","username":"zaneb"},"change_message_id":"82b49f93e2780387bf11d65e7a787536680b342e","unresolved":false,"context_lines":[{"line_number":57,"context_line":"  * contributor/ -- anything having to do with contributing to the project"},{"line_number":58,"context_line":"    (applies to most of the current content under /developer, but not all"},{"line_number":59,"context_line":"    contributors are developers and \"developer\" can be interpreted as"},{"line_number":60,"context_line":"    \"contributor\" and \"user of this library\")"},{"line_number":61,"context_line":"  * configuration/ -- automatically generated (we hope) configuration reference"},{"line_number":62,"context_line":"    information as well as (we further hope) prose explaining what all of those"},{"line_number":63,"context_line":"    options mean and how to use them sensibly"}],"source_content_type":"text/x-rst","patch_set":4,"id":"7f231b9d_42a6d8c3","line":60,"updated":"2017-06-12 16:21:42.000000000","message":"+1, this was really confusing to have a conversation about.","commit_id":"cdfb9e3f33e1752dbb6104097dc4d738658cb757"},{"author":{"_account_id":5314,"name":"Brian Rosmaita","email":"rosmaita.fossdev@gmail.com","username":"brian-rosmaita"},"change_message_id":"af421840e1f809c63ed0454072538cb1574dfc25","unresolved":false,"context_lines":[{"line_number":61,"context_line":"  * configuration/ -- automatically generated (we hope) configuration reference"},{"line_number":62,"context_line":"    information as well as (we further hope) prose explaining what all of those"},{"line_number":63,"context_line":"    options mean and how to use them sensibly"},{"line_number":64,"context_line":"  * cli/ -- anything having to do with using command line tools"},{"line_number":65,"context_line":"  * admin/ -- any admin guide content"},{"line_number":66,"context_line":"  * library/ -- any reference and user information associated with a library"},{"line_number":67,"context_line":"    that is not covered by one of the above categories"}],"source_content_type":"text/x-rst","patch_set":4,"id":"7f231b9d_1ea9e322","line":64,"range":{"start_line":64,"start_character":4,"end_line":64,"end_character":63},"updated":"2017-06-15 20:12:46.000000000","message":"Not sure this is the appropriate place to ask, but looking at the current CLI guide, it looks like for glance, for instance,  this content:\n\nhttps://docs.openstack.org/user-guide/cli-manage-images-curl.html\n\nwould go under doc/source/cli in the glance repo, but this content:\n\nhttps://docs.openstack.org/user-guide/common/cli-manage-images.html\n\nwould not, because it\u0027s about using the openstack client, so it would be maintained by the OSC team.\n\nAlso, following up on a question Akihiro asks below, where would we put docs about using the glanceclient CLI?   Would they go here or in the python-glanceclient repo?","commit_id":"cdfb9e3f33e1752dbb6104097dc4d738658cb757"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"e28724a1d2be1d5e8feb879b10ebed8621902d64","unresolved":false,"context_lines":[{"line_number":61,"context_line":"  * configuration/ -- automatically generated (we hope) configuration reference"},{"line_number":62,"context_line":"    information as well as (we further hope) prose explaining what all of those"},{"line_number":63,"context_line":"    options mean and how to use them sensibly"},{"line_number":64,"context_line":"  * cli/ -- anything having to do with using command line tools"},{"line_number":65,"context_line":"  * admin/ -- any admin guide content"},{"line_number":66,"context_line":"  * library/ -- any reference and user information associated with a library"},{"line_number":67,"context_line":"    that is not covered by one of the above categories"}],"source_content_type":"text/x-rst","patch_set":4,"id":"7f231b9d_e251c837","line":64,"range":{"start_line":64,"start_character":4,"end_line":64,"end_character":63},"in_reply_to":"7f231b9d_12ee72ec","updated":"2017-06-16 19:00:43.000000000","message":"Done","commit_id":"cdfb9e3f33e1752dbb6104097dc4d738658cb757"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"9526760f9daaf00eb75a92c2984b846190cc210a","unresolved":false,"context_lines":[{"line_number":61,"context_line":"  * configuration/ -- automatically generated (we hope) configuration reference"},{"line_number":62,"context_line":"    information as well as (we further hope) prose explaining what all of those"},{"line_number":63,"context_line":"    options mean and how to use them sensibly"},{"line_number":64,"context_line":"  * cli/ -- anything having to do with using command line tools"},{"line_number":65,"context_line":"  * admin/ -- any admin guide content"},{"line_number":66,"context_line":"  * library/ -- any reference and user information associated with a library"},{"line_number":67,"context_line":"    that is not covered by one of the above categories"}],"source_content_type":"text/x-rst","patch_set":4,"id":"7f231b9d_12ee72ec","line":64,"range":{"start_line":64,"start_character":4,"end_line":64,"end_character":63},"in_reply_to":"7f231b9d_1ea9e322","updated":"2017-06-15 22:40:58.000000000","message":"Docs about a thing go in the repo with the thing. So glance client docs would go in the glance client repo.\n\nSee https://review.openstack.org/#/q/topic:doc-migration+project:%255Eopenstack/.*glance.* for my proposed locations for all of the files I identified as being related to glance.","commit_id":"cdfb9e3f33e1752dbb6104097dc4d738658cb757"},{"author":{"_account_id":4257,"name":"Zane Bitter","email":"zbitter@redhat.com","username":"zaneb"},"change_message_id":"82b49f93e2780387bf11d65e7a787536680b342e","unresolved":false,"context_lines":[{"line_number":64,"context_line":"  * cli/ -- anything having to do with using command line tools"},{"line_number":65,"context_line":"  * admin/ -- any admin guide content"},{"line_number":66,"context_line":"  * library/ -- any reference and user information associated with a library"},{"line_number":67,"context_line":"    that is not covered by one of the above categories"},{"line_number":68,"context_line":""},{"line_number":69,"context_line":"During a later phase, we will merge the API reference and release notes builds"},{"line_number":70,"context_line":"into the same job, along with the rest of the documentation for a project."}],"source_content_type":"text/x-rst","patch_set":4,"id":"7f231b9d_421938d5","line":67,"updated":"2017-06-12 16:21:42.000000000","message":"So the only sections here aimed at actual users are the cli and api guides.\n\nI mention this because Heat needs somewhere to put its template guide, and none of these sections are it. But more broadly, do we really have nothing to communicate to our end users beyond \u0027here are the APIs\u0027?","commit_id":"cdfb9e3f33e1752dbb6104097dc4d738658cb757"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"133b3597c28cfbe0edc87f5013d36fc62988bec5","unresolved":false,"context_lines":[{"line_number":64,"context_line":"  * cli/ -- anything having to do with using command line tools"},{"line_number":65,"context_line":"  * admin/ -- any admin guide content"},{"line_number":66,"context_line":"  * library/ -- any reference and user information associated with a library"},{"line_number":67,"context_line":"    that is not covered by one of the above categories"},{"line_number":68,"context_line":""},{"line_number":69,"context_line":"During a later phase, we will merge the API reference and release notes builds"},{"line_number":70,"context_line":"into the same job, along with the rest of the documentation for a project."}],"source_content_type":"text/x-rst","patch_set":4,"id":"7f231b9d_9d4a1553","line":67,"in_reply_to":"7f231b9d_421938d5","updated":"2017-06-12 16:28:16.000000000","message":"That\u0027s a good point, and something we should have called out.\n\nThis layout is the *minimum* set. Projects are free and encouraged to add whatever other docs they need beyond this list, but we specified these items because we already have links to them from landing pages. So heat could have a /templates section, for example.\n\nThe existing end-user guide only had some content that is moving to the OSC reference. When we update that landing page, I think it would make sense to add other links to project-specific user docs. I don\u0027t know if we want to add a /user section or deep link directly to /templates and whatever else projects have. I don\u0027t want to increase the scope of this spec, though, to cover \"add lots of user-facing documentation\" so I hesitate to include that level of detail here.","commit_id":"cdfb9e3f33e1752dbb6104097dc4d738658cb757"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"e28724a1d2be1d5e8feb879b10ebed8621902d64","unresolved":false,"context_lines":[{"line_number":64,"context_line":"  * cli/ -- anything having to do with using command line tools"},{"line_number":65,"context_line":"  * admin/ -- any admin guide content"},{"line_number":66,"context_line":"  * library/ -- any reference and user information associated with a library"},{"line_number":67,"context_line":"    that is not covered by one of the above categories"},{"line_number":68,"context_line":""},{"line_number":69,"context_line":"During a later phase, we will merge the API reference and release notes builds"},{"line_number":70,"context_line":"into the same job, along with the rest of the documentation for a project."}],"source_content_type":"text/x-rst","patch_set":4,"id":"7f231b9d_8227b4ca","line":67,"in_reply_to":"7f231b9d_9d4a1553","updated":"2017-06-16 19:00:43.000000000","message":"Done","commit_id":"cdfb9e3f33e1752dbb6104097dc4d738658cb757"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"15ef74e017497269c3e1ad41e354c78a804036cb","unresolved":false,"context_lines":[{"line_number":65,"context_line":"  * admin/ -- any admin guide content"},{"line_number":66,"context_line":"  * library/ -- any reference and user information associated with a library"},{"line_number":67,"context_line":"    that is not covered by one of the above categories"},{"line_number":68,"context_line":""},{"line_number":69,"context_line":"During a later phase, we will merge the API reference and release notes builds"},{"line_number":70,"context_line":"into the same job, along with the rest of the documentation for a project."},{"line_number":71,"context_line":"Both of those builds have custom considerations, though, and it is more"}],"source_content_type":"text/x-rst","patch_set":4,"id":"7f231b9d_3893975d","line":68,"updated":"2017-06-15 18:59:06.000000000","message":"The glance project has some end-user docs (yay, glance team!) so we need to add a user/ subdirectory here for things that the end-user might want that are not part of the API reference and that are not admin stuff. It looks like their content is mostly concepts.","commit_id":"cdfb9e3f33e1752dbb6104097dc4d738658cb757"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"e28724a1d2be1d5e8feb879b10ebed8621902d64","unresolved":false,"context_lines":[{"line_number":65,"context_line":"  * admin/ -- any admin guide content"},{"line_number":66,"context_line":"  * library/ -- any reference and user information associated with a library"},{"line_number":67,"context_line":"    that is not covered by one of the above categories"},{"line_number":68,"context_line":""},{"line_number":69,"context_line":"During a later phase, we will merge the API reference and release notes builds"},{"line_number":70,"context_line":"into the same job, along with the rest of the documentation for a project."},{"line_number":71,"context_line":"Both of those builds have custom considerations, though, and it is more"}],"source_content_type":"text/x-rst","patch_set":4,"id":"7f231b9d_422d1ca6","line":68,"in_reply_to":"7f231b9d_3893975d","updated":"2017-06-16 19:00:43.000000000","message":"Done","commit_id":"cdfb9e3f33e1752dbb6104097dc4d738658cb757"},{"author":{"_account_id":10239,"name":"Dmitry Tantsur","email":"dtantsur@protonmail.com","username":"dtantsur"},"change_message_id":"25f17f978d7a890284cdf287c3ad9d80bd706919","unresolved":false,"context_lines":[{"line_number":66,"context_line":"  * library/ -- any reference and user information associated with a library"},{"line_number":67,"context_line":"    that is not covered by one of the above categories"},{"line_number":68,"context_line":""},{"line_number":69,"context_line":"During a later phase, we will merge the API reference and release notes builds"},{"line_number":70,"context_line":"into the same job, along with the rest of the documentation for a project."},{"line_number":71,"context_line":"Both of those builds have custom considerations, though, and it is more"},{"line_number":72,"context_line":"important to move the content that is no longer going to be maintained"},{"line_number":73,"context_line":"by the documentation team."}],"source_content_type":"text/x-rst","patch_set":4,"id":"7f231b9d_82d750ee","line":70,"range":{"start_line":69,"start_character":0,"end_line":70,"end_character":74},"updated":"2017-06-12 16:17:38.000000000","message":"the same applies to the install-guide for those team who already has it in tree, right?","commit_id":"cdfb9e3f33e1752dbb6104097dc4d738658cb757"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"c0dcc99deea15e90b45a9c33f5b41a0d7da96ed0","unresolved":false,"context_lines":[{"line_number":74,"context_line":""},{"line_number":75,"context_line":"* doc/source/"},{"line_number":76,"context_line":""},{"line_number":77,"context_line":"  * api/ -- the REST API reference"},{"line_number":78,"context_line":"  * releasenotes/ -- reno directions (the actual release notes inputs will stay"},{"line_number":79,"context_line":"    in /releasenotes/notes, where they are now)"},{"line_number":80,"context_line":""}],"source_content_type":"text/x-rst","patch_set":4,"id":"7f231b9d_a93a0231","line":77,"updated":"2017-06-13 21:14:58.000000000","message":"This is going to clash with the way pbr generates Python-API docs. I have a patch up to pbr to let us configure that location. After that lands, we can add steps here to describe updating the settings to point this to a subdirectory of the contributor tree.\n\nhttps://review.openstack.org/473983","commit_id":"cdfb9e3f33e1752dbb6104097dc4d738658cb757"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"e28724a1d2be1d5e8feb879b10ebed8621902d64","unresolved":false,"context_lines":[{"line_number":74,"context_line":""},{"line_number":75,"context_line":"* doc/source/"},{"line_number":76,"context_line":""},{"line_number":77,"context_line":"  * api/ -- the REST API reference"},{"line_number":78,"context_line":"  * releasenotes/ -- reno directions (the actual release notes inputs will stay"},{"line_number":79,"context_line":"    in /releasenotes/notes, where they are now)"},{"line_number":80,"context_line":""}],"source_content_type":"text/x-rst","patch_set":4,"id":"7f231b9d_8210d458","line":77,"in_reply_to":"7f231b9d_72ada699","updated":"2017-06-16 19:00:43.000000000","message":"Done","commit_id":"cdfb9e3f33e1752dbb6104097dc4d738658cb757"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"9526760f9daaf00eb75a92c2984b846190cc210a","unresolved":false,"context_lines":[{"line_number":74,"context_line":""},{"line_number":75,"context_line":"* doc/source/"},{"line_number":76,"context_line":""},{"line_number":77,"context_line":"  * api/ -- the REST API reference"},{"line_number":78,"context_line":"  * releasenotes/ -- reno directions (the actual release notes inputs will stay"},{"line_number":79,"context_line":"    in /releasenotes/notes, where they are now)"},{"line_number":80,"context_line":""}],"source_content_type":"text/x-rst","patch_set":4,"id":"7f231b9d_72ada699","line":77,"in_reply_to":"7f231b9d_84d92e58","updated":"2017-06-15 22:40:58.000000000","message":"I had intended for us to use subdirectories under doc/source/api/. This is all phase 2 stuff though, so I would prefer to postpone any discussion until we actually start that. I will add a note that these are tentative locations, and will be discussed later when we are ready to combine those guides.","commit_id":"cdfb9e3f33e1752dbb6104097dc4d738658cb757"},{"author":{"_account_id":5314,"name":"Brian Rosmaita","email":"rosmaita.fossdev@gmail.com","username":"brian-rosmaita"},"change_message_id":"d8653fc03380061ed335066732049f4139f91bb2","unresolved":false,"context_lines":[{"line_number":74,"context_line":""},{"line_number":75,"context_line":"* doc/source/"},{"line_number":76,"context_line":""},{"line_number":77,"context_line":"  * api/ -- the REST API reference"},{"line_number":78,"context_line":"  * releasenotes/ -- reno directions (the actual release notes inputs will stay"},{"line_number":79,"context_line":"    in /releasenotes/notes, where they are now)"},{"line_number":80,"context_line":""}],"source_content_type":"text/x-rst","patch_set":4,"id":"7f231b9d_84d92e58","line":77,"in_reply_to":"7f231b9d_a93a0231","updated":"2017-06-15 13:59:07.000000000","message":"I want to follow up on something Anne brought up on PS 3, namely that some projects (nova for sure) have an api-ref/ and api-guide/, and these currently generate different docs with similar but different content (the api-ref is a quick reference guide, the api-guide goes into more detail).  (Glance has an api-guide currently in the glance-specs repo, we\u0027re planning to bring it over to the glance repo, so we\u0027ll be in the same situation.)  I don\u0027t know what level we\u0027d want to make the distinction, i.e.,:\n\ndoc/source/api/ref\ndoc/source/api/guide\n\nor\n\ndoc/source/api-ref\ndoc/source/api-guide","commit_id":"cdfb9e3f33e1752dbb6104097dc4d738658cb757"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"11b6bbdd02944a8934e32ec18c4ccfb01aa8c298","unresolved":false,"context_lines":[{"line_number":123,"context_line":"  * The current guide is actually built 3 separate times, to cover 3 separate"},{"line_number":124,"context_line":"    deployment platforms. The new build will not support that, so the migration"},{"line_number":125,"context_line":"    for the installation guide will involve breaking the content up into"},{"line_number":126,"context_line":"    separate pages for each platform (as needed)."},{"line_number":127,"context_line":""},{"line_number":128,"context_line":"* Project Installation guides, already in tree"},{"line_number":129,"context_line":""}],"source_content_type":"text/x-rst","patch_set":4,"id":"7f231b9d_f4835b03","line":126,"updated":"2017-06-12 20:53:54.000000000","message":"I\u0027ve prepared a version of the content with instructions for each platform we support today in https://review.openstack.org/473579 to make it easier for project teams to get the files they need to migrate. That patch does the bulk editing, but we will still need to do some renaming by hand as the files are moved to their new locations.","commit_id":"cdfb9e3f33e1752dbb6104097dc4d738658cb757"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"e28724a1d2be1d5e8feb879b10ebed8621902d64","unresolved":false,"context_lines":[{"line_number":123,"context_line":"  * The current guide is actually built 3 separate times, to cover 3 separate"},{"line_number":124,"context_line":"    deployment platforms. The new build will not support that, so the migration"},{"line_number":125,"context_line":"    for the installation guide will involve breaking the content up into"},{"line_number":126,"context_line":"    separate pages for each platform (as needed)."},{"line_number":127,"context_line":""},{"line_number":128,"context_line":"* Project Installation guides, already in tree"},{"line_number":129,"context_line":""}],"source_content_type":"text/x-rst","patch_set":4,"id":"7f231b9d_e52d5295","line":126,"in_reply_to":"7f231b9d_f4835b03","updated":"2017-06-16 19:00:43.000000000","message":"Done","commit_id":"cdfb9e3f33e1752dbb6104097dc4d738658cb757"},{"author":{"_account_id":10239,"name":"Dmitry Tantsur","email":"dtantsur@protonmail.com","username":"dtantsur"},"change_message_id":"25f17f978d7a890284cdf287c3ad9d80bd706919","unresolved":false,"context_lines":[{"line_number":127,"context_line":""},{"line_number":128,"context_line":"* Project Installation guides, already in tree"},{"line_number":129,"context_line":""},{"line_number":130,"context_line":"  * We recommend any installation guides already in-tree also move to the new"},{"line_number":131,"context_line":"    organization."},{"line_number":132,"context_line":""},{"line_number":133,"context_line":"* Administrator Guide"},{"line_number":134,"context_line":""}],"source_content_type":"text/x-rst","patch_set":4,"id":"7f231b9d_c2f66890","line":131,"range":{"start_line":130,"start_character":0,"end_line":131,"end_character":17},"updated":"2017-06-12 16:17:38.000000000","message":"aha, got it","commit_id":"cdfb9e3f33e1752dbb6104097dc4d738658cb757"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"e28724a1d2be1d5e8feb879b10ebed8621902d64","unresolved":false,"context_lines":[{"line_number":127,"context_line":""},{"line_number":128,"context_line":"* Project Installation guides, already in tree"},{"line_number":129,"context_line":""},{"line_number":130,"context_line":"  * We recommend any installation guides already in-tree also move to the new"},{"line_number":131,"context_line":"    organization."},{"line_number":132,"context_line":""},{"line_number":133,"context_line":"* Administrator Guide"},{"line_number":134,"context_line":""}],"source_content_type":"text/x-rst","patch_set":4,"id":"7f231b9d_c520169e","line":131,"range":{"start_line":130,"start_character":0,"end_line":131,"end_character":17},"in_reply_to":"7f231b9d_c2f66890","updated":"2017-06-16 19:00:43.000000000","message":"Done","commit_id":"cdfb9e3f33e1752dbb6104097dc4d738658cb757"},{"author":{"_account_id":841,"name":"Akihiro Motoki","email":"amotoki@gmail.com","username":"amotoki"},"change_message_id":"5b482868e2c5c1c197245ee6c4d43fd605839e80","unresolved":false,"context_lines":[{"line_number":190,"context_line":"* Command-Line Reference"},{"line_number":191,"context_line":""},{"line_number":192,"context_line":"  * This content will move the project-specific client documentation trees"},{"line_number":193,"context_line":"    under doc/source/cli"},{"line_number":194,"context_line":""},{"line_number":195,"context_line":"* Virtual Machine Image Reference"},{"line_number":196,"context_line":"  * This content will stay in openstack-manuals."}],"source_content_type":"text/x-rst","patch_set":4,"id":"7f231b9d_911bafc8","line":193,"updated":"2017-06-15 15:07:47.000000000","message":"Does this mean e have CLI reference in python-*client repositories?","commit_id":"cdfb9e3f33e1752dbb6104097dc4d738658cb757"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"e28724a1d2be1d5e8feb879b10ebed8621902d64","unresolved":false,"context_lines":[{"line_number":190,"context_line":"* Command-Line Reference"},{"line_number":191,"context_line":""},{"line_number":192,"context_line":"  * This content will move the project-specific client documentation trees"},{"line_number":193,"context_line":"    under doc/source/cli"},{"line_number":194,"context_line":""},{"line_number":195,"context_line":"* Virtual Machine Image Reference"},{"line_number":196,"context_line":"  * This content will stay in openstack-manuals."}],"source_content_type":"text/x-rst","patch_set":4,"id":"7f231b9d_853e9ebe","line":193,"in_reply_to":"7f231b9d_911bafc8","updated":"2017-06-16 19:00:43.000000000","message":"Yes, exactly.","commit_id":"cdfb9e3f33e1752dbb6104097dc4d738658cb757"},{"author":{"_account_id":10239,"name":"Dmitry Tantsur","email":"dtantsur@protonmail.com","username":"dtantsur"},"change_message_id":"25f17f978d7a890284cdf287c3ad9d80bd706919","unresolved":false,"context_lines":[{"line_number":204,"context_line":"repositories, instead of having the documentation team \"push\" it."},{"line_number":205,"context_line":""},{"line_number":206,"context_line":"#. Pull in the content being migrated, following the layout above."},{"line_number":207,"context_line":"#. Move the existing contributor-focused content to fit the layout above."},{"line_number":208,"context_line":"#. Update the theme for the in-tree docs to use the openstackdocstheme"},{"line_number":209,"context_line":"   instead of oslosphinx."},{"line_number":210,"context_line":"#. Add auto-generated config reference section(s)."}],"source_content_type":"text/x-rst","patch_set":4,"id":"7f231b9d_e26cc437","line":207,"range":{"start_line":207,"start_character":0,"end_line":207,"end_character":73},"updated":"2017-06-12 16:17:38.000000000","message":"it\u0027s not clear how we do it, while keeping the links working all the time. e.g. I cannot do\n\n git mv doc/source doc/source/contributor\n\nas the current jobs will rebuild the dev docs and break the links.","commit_id":"cdfb9e3f33e1752dbb6104097dc4d738658cb757"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"244ae9f770eb93df4ddcd7ef68d69a1dd51d1ab2","unresolved":false,"context_lines":[{"line_number":204,"context_line":"repositories, instead of having the documentation team \"push\" it."},{"line_number":205,"context_line":""},{"line_number":206,"context_line":"#. Pull in the content being migrated, following the layout above."},{"line_number":207,"context_line":"#. Move the existing contributor-focused content to fit the layout above."},{"line_number":208,"context_line":"#. Update the theme for the in-tree docs to use the openstackdocstheme"},{"line_number":209,"context_line":"   instead of oslosphinx."},{"line_number":210,"context_line":"#. Add auto-generated config reference section(s)."}],"source_content_type":"text/x-rst","patch_set":4,"id":"7f231b9d_e27604d9","line":207,"range":{"start_line":207,"start_character":0,"end_line":207,"end_character":73},"in_reply_to":"7f231b9d_e26cc437","updated":"2017-06-12 16:22:09.000000000","message":"The content in the old location will be replaced by redirects to the new location.","commit_id":"cdfb9e3f33e1752dbb6104097dc4d738658cb757"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"e28724a1d2be1d5e8feb879b10ebed8621902d64","unresolved":false,"context_lines":[{"line_number":204,"context_line":"repositories, instead of having the documentation team \"push\" it."},{"line_number":205,"context_line":""},{"line_number":206,"context_line":"#. Pull in the content being migrated, following the layout above."},{"line_number":207,"context_line":"#. Move the existing contributor-focused content to fit the layout above."},{"line_number":208,"context_line":"#. Update the theme for the in-tree docs to use the openstackdocstheme"},{"line_number":209,"context_line":"   instead of oslosphinx."},{"line_number":210,"context_line":"#. Add auto-generated config reference section(s)."}],"source_content_type":"text/x-rst","patch_set":4,"id":"7f231b9d_a5719aaa","line":207,"range":{"start_line":207,"start_character":0,"end_line":207,"end_character":73},"in_reply_to":"7f231b9d_e27604d9","updated":"2017-06-16 19:00:43.000000000","message":"The old build job and the new build job will both run sphinx assuming that doc/source is the top of the source tree. So you need to rearrange the content inside that directory, but that won\u0027t break either build. Does that make sense?","commit_id":"cdfb9e3f33e1752dbb6104097dc4d738658cb757"},{"author":{"_account_id":11904,"name":"Sean McGinnis","email":"sean.mcginnis@gmail.com","username":"SeanM"},"change_message_id":"f7dd7db584466d10a4a70db56b71711327e9af7d","unresolved":false,"context_lines":[{"line_number":69,"context_line":"    configuration reference information as well as (we further hope)"},{"line_number":70,"context_line":"    prose explaining what all of those options mean and how to use"},{"line_number":71,"context_line":"    them sensibly"},{"line_number":72,"context_line":"  * ``cli/`` -- anything having to do with using command line tools"},{"line_number":73,"context_line":"  * ``admin/`` -- any admin guide content"},{"line_number":74,"context_line":"  * ``library/`` -- any reference and user information associated with"},{"line_number":75,"context_line":"    a library that is not covered by one of the above categories"}],"source_content_type":"text/x-rst","patch_set":6,"id":"7f231b9d_af43973e","line":72,"range":{"start_line":72,"start_character":6,"end_line":72,"end_character":9},"updated":"2017-06-19 12:40:58.000000000","message":"If I am understanding this correctly, while here it looks like cli/ would be in the \"base\" project, line 215 would indicate otherwise.\n\nIn other words, the Cinder cli documentation would not go in openstack/cinder, but in openstack/python-cinderclient, correct?\n\nAnd that documentation would get pulled together and published in the same location?\n\nAt the risk of making this line too wordy, it might be good to add a little clarification here to make sure this is understood.","commit_id":"843e9e73b06fed0568d433fcdacf612d8bc5ab5f"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"48ccc847c984b49336c72bd0fd8696e9b575153f","unresolved":false,"context_lines":[{"line_number":69,"context_line":"    configuration reference information as well as (we further hope)"},{"line_number":70,"context_line":"    prose explaining what all of those options mean and how to use"},{"line_number":71,"context_line":"    them sensibly"},{"line_number":72,"context_line":"  * ``cli/`` -- anything having to do with using command line tools"},{"line_number":73,"context_line":"  * ``admin/`` -- any admin guide content"},{"line_number":74,"context_line":"  * ``library/`` -- any reference and user information associated with"},{"line_number":75,"context_line":"    a library that is not covered by one of the above categories"}],"source_content_type":"text/x-rst","patch_set":6,"id":"7f231b9d_4fe8837a","line":72,"range":{"start_line":72,"start_character":6,"end_line":72,"end_character":9},"in_reply_to":"7f231b9d_2f366752","updated":"2017-06-19 13:00:22.000000000","message":"I tweaked the paragraphs above this list in the latest draft.","commit_id":"843e9e73b06fed0568d433fcdacf612d8bc5ab5f"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"4c4e0e9d79223913407939208f2421faebbe857d","unresolved":false,"context_lines":[{"line_number":69,"context_line":"    configuration reference information as well as (we further hope)"},{"line_number":70,"context_line":"    prose explaining what all of those options mean and how to use"},{"line_number":71,"context_line":"    them sensibly"},{"line_number":72,"context_line":"  * ``cli/`` -- anything having to do with using command line tools"},{"line_number":73,"context_line":"  * ``admin/`` -- any admin guide content"},{"line_number":74,"context_line":"  * ``library/`` -- any reference and user information associated with"},{"line_number":75,"context_line":"    a library that is not covered by one of the above categories"}],"source_content_type":"text/x-rst","patch_set":6,"id":"7f231b9d_2f366752","line":72,"range":{"start_line":72,"start_character":6,"end_line":72,"end_character":9},"in_reply_to":"7f231b9d_af43973e","updated":"2017-06-19 12:57:51.000000000","message":"The idea is that if a repo has content in one of these topic areas, it goes into a directory with one of the pre-defined names to make the landing page construction simpler.\n\nSo, if cinder has a cinder-manage command or wants to document the CLI arguments to the cinder daemons, that would go in the cinder repo.\n\nThe python-cinderclient repo would contain the docs for the regular cinder command line tool\n\nMake sense?","commit_id":"843e9e73b06fed0568d433fcdacf612d8bc5ab5f"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"2661af5107e08d2c811c9e55320f490a45a382c0","unresolved":false,"context_lines":[{"line_number":177,"context_line":""},{"line_number":178,"context_line":"  * This content will stay in openstack-manuals, and be managed by the"},{"line_number":179,"context_line":"    security team."},{"line_number":180,"context_line":"  * A notice is being added to indicate the last time it was updated"},{"line_number":181,"context_line":"    and which release is relevant"},{"line_number":182,"context_line":"    (https://review.openstack.org/#/c/470059)."},{"line_number":183,"context_line":""}],"source_content_type":"text/x-rst","patch_set":6,"id":"7f231b9d_d4c78a63","line":180,"range":{"start_line":180,"start_character":13,"end_line":180,"end_character":21},"updated":"2017-06-19 12:29:37.000000000","message":"has been added * (really small nit)","commit_id":"843e9e73b06fed0568d433fcdacf612d8bc5ab5f"},{"author":{"_account_id":20156,"name":"Petr Kovar","email":"pkovar@redhat.com","username":"pmkovar"},"change_message_id":"a8f9eafe3b1f8920aefe456f1c7a38e29f53e306","unresolved":false,"context_lines":[{"line_number":141,"context_line":""},{"line_number":142,"context_line":"  * Most of the content will move from openstack-manuals into each project"},{"line_number":143,"context_line":"    tree."},{"line_number":144,"context_line":"  * The chapters not directly related to specific OpenStack projects, such as"},{"line_number":145,"context_line":"    the parts related to installing ntp and RabbitMQ, will be retained in"},{"line_number":146,"context_line":"    openstack-manuals in a new, pared down, \"Before You Install\" guide."},{"line_number":147,"context_line":"  * The current guide is actually built 3 separate times, to cover 3"}],"source_content_type":"text/x-rst","patch_set":7,"id":"7f231b9d_804f8569","line":144,"updated":"2017-06-19 15:22:45.000000000","message":"Can we update this para per the earlier discussion?","commit_id":"d93e976d69e5508639cf329846aec1481b47c2fc"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"b4eaaf81aa556091ef11290e3214892a9a805b94","unresolved":false,"context_lines":[{"line_number":141,"context_line":""},{"line_number":142,"context_line":"  * Most of the content will move from openstack-manuals into each project"},{"line_number":143,"context_line":"    tree."},{"line_number":144,"context_line":"  * The chapters not directly related to specific OpenStack projects, such as"},{"line_number":145,"context_line":"    the parts related to installing ntp and RabbitMQ, will be retained in"},{"line_number":146,"context_line":"    openstack-manuals in a new, pared down, \"Before You Install\" guide."},{"line_number":147,"context_line":"  * The current guide is actually built 3 separate times, to cover 3"}],"source_content_type":"text/x-rst","patch_set":7,"id":"7f231b9d_363fd888","line":144,"in_reply_to":"7f231b9d_804f8569","updated":"2017-06-19 18:02:10.000000000","message":"Done","commit_id":"d93e976d69e5508639cf329846aec1481b47c2fc"},{"author":{"_account_id":6537,"name":"gordon chung","email":"gord@live.ca","username":"chungg"},"change_message_id":"b0a6c2e74380e232786d1f4f4abbc597ba4b5487","unresolved":false,"context_lines":[{"line_number":153,"context_line":""},{"line_number":154,"context_line":"* Project Installation guides, already in tree"},{"line_number":155,"context_line":""},{"line_number":156,"context_line":"  * We recommend any installation guides already in-tree also move to the new"},{"line_number":157,"context_line":"    organization."},{"line_number":158,"context_line":""},{"line_number":159,"context_line":"* Administrator Guide"}],"source_content_type":"text/x-rst","patch_set":7,"id":"7f231b9d_ece872e2","line":156,"updated":"2017-06-19 17:37:59.000000000","message":"for the existing in-tree project install guides, they are under openstack/\u003cproject\u003e/install-guide/source (at least for ceilometer)... does this mean we should keep that and create a copy under openstack/\u003cproject\u003e/doc/source/install?\n\nthere is also a conf.py[1]. should there be one for each of these separate guide folders?\n\n\n[1] https://github.com/openstack/ceilometer/blob/master/install-guide/source/conf.py","commit_id":"d93e976d69e5508639cf329846aec1481b47c2fc"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"b4eaaf81aa556091ef11290e3214892a9a805b94","unresolved":false,"context_lines":[{"line_number":153,"context_line":""},{"line_number":154,"context_line":"* Project Installation guides, already in tree"},{"line_number":155,"context_line":""},{"line_number":156,"context_line":"  * We recommend any installation guides already in-tree also move to the new"},{"line_number":157,"context_line":"    organization."},{"line_number":158,"context_line":""},{"line_number":159,"context_line":"* Administrator Guide"}],"source_content_type":"text/x-rst","patch_set":7,"id":"7f231b9d_d66e6495","line":156,"in_reply_to":"7f231b9d_ece872e2","updated":"2017-06-19 18:02:10.000000000","message":"No, when you move that content, only move the *content* not the build stuff. We eventually want 1 documentation build per project.","commit_id":"d93e976d69e5508639cf329846aec1481b47c2fc"},{"author":{"_account_id":5046,"name":"Lance Bragstad","email":"lbragstad@redhat.com","username":"ldbragst"},"change_message_id":"add96a116ccd5aa9857be0c6e01330baf67d6f3a","unresolved":false,"context_lines":[{"line_number":245,"context_line":"   Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454`` to tie it to this"},{"line_number":246,"context_line":"   spec."},{"line_number":247,"context_line":"#. If your project docs are not already building using"},{"line_number":248,"context_line":"   warning-is-error in setup.cfg, turn that on any fix any build"},{"line_number":249,"context_line":"   errors. Submit these as patches on top of the first patch."},{"line_number":250,"context_line":"#. Pull in the content being migrated, following the layout above."},{"line_number":251,"context_line":""}],"source_content_type":"text/x-rst","patch_set":7,"id":"7f231b9d_8a1c4678","line":248,"updated":"2017-06-19 14:55:28.000000000","message":"nit: turn that on to fix*","commit_id":"d93e976d69e5508639cf329846aec1481b47c2fc"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"b4eaaf81aa556091ef11290e3214892a9a805b94","unresolved":false,"context_lines":[{"line_number":245,"context_line":"   Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454`` to tie it to this"},{"line_number":246,"context_line":"   spec."},{"line_number":247,"context_line":"#. If your project docs are not already building using"},{"line_number":248,"context_line":"   warning-is-error in setup.cfg, turn that on any fix any build"},{"line_number":249,"context_line":"   errors. Submit these as patches on top of the first patch."},{"line_number":250,"context_line":"#. Pull in the content being migrated, following the layout above."},{"line_number":251,"context_line":""}],"source_content_type":"text/x-rst","patch_set":7,"id":"7f231b9d_560814d8","line":248,"in_reply_to":"7f231b9d_8a1c4678","updated":"2017-06-19 18:02:10.000000000","message":"Done","commit_id":"d93e976d69e5508639cf329846aec1481b47c2fc"},{"author":{"_account_id":5263,"name":"Jeremy Stanley","display_name":"fungi","email":"fungi@yuggoth.org","username":"fungi","status":"missing, presumed fed"},"change_message_id":"200f3ba27a9045083725532c94c3e38c0c9f3f66","unresolved":false,"context_lines":[{"line_number":274,"context_line":"   items in the sections dedicated to each manual. That way the docs"},{"line_number":275,"context_line":"   team will know when it is safe to start deleting content."},{"line_number":276,"context_line":"#. After the content and docs jobs for a repo are updated, set up the redirect"},{"line_number":277,"context_line":"   from /developer to the new /contributor location."},{"line_number":278,"context_line":"#. If the project has a service-type, add a redirect from"},{"line_number":279,"context_line":"   /$service-type to /$project-name. For example, ``/compute`` should"},{"line_number":280,"context_line":"   redirect to ``/nova``."}],"source_content_type":"text/x-rst","patch_set":7,"id":"5f201791_3ee1e8ff","line":277,"updated":"2017-06-20 16:34:01.000000000","message":"Out of curiosity, how is this step being managed? I understand that for the repos maintained by the Docs team they should be able to add .htaccess files setting up redirects to whatever out-of-tree locations where the new content lives, but documentation under /developer getting moved to new places implies some central set of redirects at the top of the tree or in the Apache configuration itself. Either of these is going to be sensitive to maintain in an inrcemental fashion (needs a central reviewer team, prone to frequent merge conflicts, easy to knock the entire docs.o.o site offline with a single typo), though if we go with direct Apache configuration we have the added risk of breaking Web services for all sites being served from the same server (currently includes tarballs.o.o, governance.o.o, security.o.o, releases.o.o, specs.o.o, logs.o.o and lots of others). Another option would be to declare a flag day and just install a one-liner blanket redirect from /developer to /.","commit_id":"d93e976d69e5508639cf329846aec1481b47c2fc"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"370792971199cdfa4e02c6e1131c39808150a917","unresolved":false,"context_lines":[{"line_number":274,"context_line":"   items in the sections dedicated to each manual. That way the docs"},{"line_number":275,"context_line":"   team will know when it is safe to start deleting content."},{"line_number":276,"context_line":"#. After the content and docs jobs for a repo are updated, set up the redirect"},{"line_number":277,"context_line":"   from /developer to the new /contributor location."},{"line_number":278,"context_line":"#. If the project has a service-type, add a redirect from"},{"line_number":279,"context_line":"   /$service-type to /$project-name. For example, ``/compute`` should"},{"line_number":280,"context_line":"   redirect to ``/nova``."}],"source_content_type":"text/x-rst","patch_set":7,"id":"5f201791_1724cfc5","line":277,"in_reply_to":"5f201791_3ee1e8ff","updated":"2017-06-20 18:31:05.000000000","message":"I should have removed this. We have a single redirect rule in https://review.openstack.org/475572 now","commit_id":"d93e976d69e5508639cf329846aec1481b47c2fc"},{"author":{"_account_id":5263,"name":"Jeremy Stanley","display_name":"fungi","email":"fungi@yuggoth.org","username":"fungi","status":"missing, presumed fed"},"change_message_id":"200f3ba27a9045083725532c94c3e38c0c9f3f66","unresolved":false,"context_lines":[{"line_number":277,"context_line":"   from /developer to the new /contributor location."},{"line_number":278,"context_line":"#. If the project has a service-type, add a redirect from"},{"line_number":279,"context_line":"   /$service-type to /$project-name. For example, ``/compute`` should"},{"line_number":280,"context_line":"   redirect to ``/nova``."},{"line_number":281,"context_line":"#. After project-specific install guides are moved into the doc tree, set up"},{"line_number":282,"context_line":"   the redirect from /project-install-guide to the new /install location."},{"line_number":283,"context_line":"#. Update the main landing page(s) starting with docs.o.o/ (see notes above)"}],"source_content_type":"text/x-rst","patch_set":7,"id":"5f201791_1ee62c18","line":280,"updated":"2017-06-20 16:34:01.000000000","message":"Where are these redirects going to be maintained? I guess we can just add the set of these in a batch since we know most of them in advance and additions are likely to be infrequent?","commit_id":"d93e976d69e5508639cf329846aec1481b47c2fc"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"370792971199cdfa4e02c6e1131c39808150a917","unresolved":false,"context_lines":[{"line_number":277,"context_line":"   from /developer to the new /contributor location."},{"line_number":278,"context_line":"#. If the project has a service-type, add a redirect from"},{"line_number":279,"context_line":"   /$service-type to /$project-name. For example, ``/compute`` should"},{"line_number":280,"context_line":"   redirect to ``/nova``."},{"line_number":281,"context_line":"#. After project-specific install guides are moved into the doc tree, set up"},{"line_number":282,"context_line":"   the redirect from /project-install-guide to the new /install location."},{"line_number":283,"context_line":"#. Update the main landing page(s) starting with docs.o.o/ (see notes above)"}],"source_content_type":"text/x-rst","patch_set":7,"id":"5f201791_771e6371","line":280,"in_reply_to":"5f201791_1ee62c18","updated":"2017-06-20 18:31:05.000000000","message":"These will go in the same htaccess file in the openstack-manuals repo for now. I\u0027ll set one up for glance as an example.","commit_id":"d93e976d69e5508639cf329846aec1481b47c2fc"},{"author":{"_account_id":5263,"name":"Jeremy Stanley","display_name":"fungi","email":"fungi@yuggoth.org","username":"fungi","status":"missing, presumed fed"},"change_message_id":"200f3ba27a9045083725532c94c3e38c0c9f3f66","unresolved":false,"context_lines":[{"line_number":307,"context_line":"We did consider using \"service type\" instead of \"project name\" for the"},{"line_number":308,"context_line":"publishing URLs, but not all of the projects that need documentations"},{"line_number":309,"context_line":"are services. We will have user-facing documentation coming from several"},{"line_number":310,"context_line":"Oslo libraries, for example."},{"line_number":311,"context_line":""},{"line_number":312,"context_line":"Implementation"},{"line_number":313,"context_line":"~~~~~~~~~~~~~~"}],"source_content_type":"text/x-rst","patch_set":7,"id":"5f201791_fee25001","line":310,"updated":"2017-06-20 16:34:01.000000000","message":"Also, this would have made the publisher logic much more complicated since we couldn\u0027t just key the destination from the repository name.","commit_id":"d93e976d69e5508639cf329846aec1481b47c2fc"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"370792971199cdfa4e02c6e1131c39808150a917","unresolved":false,"context_lines":[{"line_number":307,"context_line":"We did consider using \"service type\" instead of \"project name\" for the"},{"line_number":308,"context_line":"publishing URLs, but not all of the projects that need documentations"},{"line_number":309,"context_line":"are services. We will have user-facing documentation coming from several"},{"line_number":310,"context_line":"Oslo libraries, for example."},{"line_number":311,"context_line":""},{"line_number":312,"context_line":"Implementation"},{"line_number":313,"context_line":"~~~~~~~~~~~~~~"}],"source_content_type":"text/x-rst","patch_set":7,"id":"5f201791_57136767","line":310,"in_reply_to":"5f201791_fee25001","updated":"2017-06-20 18:31:05.000000000","message":"Good point.","commit_id":"d93e976d69e5508639cf329846aec1481b47c2fc"},{"author":{"_account_id":15334,"name":"Stephen Finucane","display_name":"stephenfin","email":"stephenfin@redhat.com","username":"sfinucan"},"change_message_id":"ee04d6740e62b58ff8271a0818aaf707b519e481","unresolved":false,"context_lines":[{"line_number":72,"context_line":"    configuration reference information as well as (we further hope)"},{"line_number":73,"context_line":"    prose explaining what all of those options mean and how to use"},{"line_number":74,"context_line":"    them sensibly"},{"line_number":75,"context_line":"  * ``cli/`` -- anything having to do with using command line tools"},{"line_number":76,"context_line":"  * ``admin/`` -- any admin guide content"},{"line_number":77,"context_line":"  * ``library/`` -- any reference and user information associated with"},{"line_number":78,"context_line":"    a library that is not covered by one of the above categories"}],"source_content_type":"text/x-rst","patch_set":8,"id":"5f201791_443a98e7","line":75,"range":{"start_line":75,"start_character":0,"end_line":75,"end_character":67},"updated":"2017-06-20 15:32:54.000000000","message":"Another one I thought of - the clients are different projects. Do we intend to move all \u0027openstack-*client\u0027 docs to whatever \u0027*\u0027 is? If not, how do we intend to build/include this subfolder?","commit_id":"3f8d16fc882ad3c0a847ed0c2377fe2800fc4164"},{"author":{"_account_id":15334,"name":"Stephen Finucane","display_name":"stephenfin","email":"stephenfin@redhat.com","username":"sfinucan"},"change_message_id":"cd9ff81e07a3035aff0819dad43fb3ec3d9d36ae","unresolved":false,"context_lines":[{"line_number":72,"context_line":"    configuration reference information as well as (we further hope)"},{"line_number":73,"context_line":"    prose explaining what all of those options mean and how to use"},{"line_number":74,"context_line":"    them sensibly"},{"line_number":75,"context_line":"  * ``cli/`` -- anything having to do with using command line tools"},{"line_number":76,"context_line":"  * ``admin/`` -- any admin guide content"},{"line_number":77,"context_line":"  * ``library/`` -- any reference and user information associated with"},{"line_number":78,"context_line":"    a library that is not covered by one of the above categories"}],"source_content_type":"text/x-rst","patch_set":8,"id":"7f231b9d_1879972e","line":75,"range":{"start_line":75,"start_character":16,"end_line":75,"end_character":67},"updated":"2017-06-20 08:46:39.000000000","message":"much of this should be autogenerated too","commit_id":"3f8d16fc882ad3c0a847ed0c2377fe2800fc4164"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"4e71457827c65b364c0ab0c91e7f742fbd5811e5","unresolved":false,"context_lines":[{"line_number":72,"context_line":"    configuration reference information as well as (we further hope)"},{"line_number":73,"context_line":"    prose explaining what all of those options mean and how to use"},{"line_number":74,"context_line":"    them sensibly"},{"line_number":75,"context_line":"  * ``cli/`` -- anything having to do with using command line tools"},{"line_number":76,"context_line":"  * ``admin/`` -- any admin guide content"},{"line_number":77,"context_line":"  * ``library/`` -- any reference and user information associated with"},{"line_number":78,"context_line":"    a library that is not covered by one of the above categories"}],"source_content_type":"text/x-rst","patch_set":8,"id":"5f201791_61e6a1eb","line":75,"range":{"start_line":75,"start_character":0,"end_line":75,"end_character":67},"in_reply_to":"5f201791_443a98e7","updated":"2017-06-20 17:07:53.000000000","message":"The docs for a thing go where the code for the thing is. So most of the command line docs will go in the repo with the client libraries.","commit_id":"3f8d16fc882ad3c0a847ed0c2377fe2800fc4164"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"443e718ccb2e349be986ca84541d351a03a57f38","unresolved":false,"context_lines":[{"line_number":72,"context_line":"    configuration reference information as well as (we further hope)"},{"line_number":73,"context_line":"    prose explaining what all of those options mean and how to use"},{"line_number":74,"context_line":"    them sensibly"},{"line_number":75,"context_line":"  * ``cli/`` -- anything having to do with using command line tools"},{"line_number":76,"context_line":"  * ``admin/`` -- any admin guide content"},{"line_number":77,"context_line":"  * ``library/`` -- any reference and user information associated with"},{"line_number":78,"context_line":"    a library that is not covered by one of the above categories"}],"source_content_type":"text/x-rst","patch_set":8,"id":"5f201791_fe493532","line":75,"range":{"start_line":75,"start_character":16,"end_line":75,"end_character":67},"in_reply_to":"7f231b9d_1879972e","updated":"2017-06-20 14:32:16.000000000","message":"+1","commit_id":"3f8d16fc882ad3c0a847ed0c2377fe2800fc4164"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"7455716aaa2a050243d61113b3ce6913a51f7d1f","unresolved":false,"context_lines":[{"line_number":72,"context_line":"    configuration reference information as well as (we further hope)"},{"line_number":73,"context_line":"    prose explaining what all of those options mean and how to use"},{"line_number":74,"context_line":"    them sensibly"},{"line_number":75,"context_line":"  * ``cli/`` -- anything having to do with using command line tools"},{"line_number":76,"context_line":"  * ``admin/`` -- any admin guide content"},{"line_number":77,"context_line":"  * ``library/`` -- any reference and user information associated with"},{"line_number":78,"context_line":"    a library that is not covered by one of the above categories"}],"source_content_type":"text/x-rst","patch_set":8,"id":"5f201791_fbe5c70b","line":75,"range":{"start_line":75,"start_character":16,"end_line":75,"end_character":67},"in_reply_to":"7f231b9d_1879972e","updated":"2017-06-20 14:09:12.000000000","message":"The reference material can. There are quite a few usage examples in the guide, too.","commit_id":"3f8d16fc882ad3c0a847ed0c2377fe2800fc4164"},{"author":{"_account_id":15334,"name":"Stephen Finucane","display_name":"stephenfin","email":"stephenfin@redhat.com","username":"sfinucan"},"change_message_id":"cd9ff81e07a3035aff0819dad43fb3ec3d9d36ae","unresolved":false,"context_lines":[{"line_number":74,"context_line":"    them sensibly"},{"line_number":75,"context_line":"  * ``cli/`` -- anything having to do with using command line tools"},{"line_number":76,"context_line":"  * ``admin/`` -- any admin guide content"},{"line_number":77,"context_line":"  * ``library/`` -- any reference and user information associated with"},{"line_number":78,"context_line":"    a library that is not covered by one of the above categories"},{"line_number":79,"context_line":"  * ``user/`` -- end-user content that doesn\u0027t fit into the other"},{"line_number":80,"context_line":"    sections (concept guides, advice, etc.)"}],"source_content_type":"text/x-rst","patch_set":8,"id":"7f231b9d_98e007cf","line":77,"range":{"start_line":77,"start_character":6,"end_line":77,"end_character":13},"updated":"2017-06-20 08:46:39.000000000","message":"nit: Both the Django and OVS docs use the term \u0027reference\u0027 (i.e. \"Reference Guide\") for this section. I would think this to be more consistent","commit_id":"3f8d16fc882ad3c0a847ed0c2377fe2800fc4164"},{"author":{"_account_id":15334,"name":"Stephen Finucane","display_name":"stephenfin","email":"stephenfin@redhat.com","username":"sfinucan"},"change_message_id":"ee04d6740e62b58ff8271a0818aaf707b519e481","unresolved":false,"context_lines":[{"line_number":74,"context_line":"    them sensibly"},{"line_number":75,"context_line":"  * ``cli/`` -- anything having to do with using command line tools"},{"line_number":76,"context_line":"  * ``admin/`` -- any admin guide content"},{"line_number":77,"context_line":"  * ``library/`` -- any reference and user information associated with"},{"line_number":78,"context_line":"    a library that is not covered by one of the above categories"},{"line_number":79,"context_line":"  * ``user/`` -- end-user content that doesn\u0027t fit into the other"},{"line_number":80,"context_line":"    sections (concept guides, advice, etc.)"}],"source_content_type":"text/x-rst","patch_set":8,"id":"5f201791_6418f4d2","line":77,"range":{"start_line":77,"start_character":6,"end_line":77,"end_character":13},"in_reply_to":"5f201791_3e59edfd","updated":"2017-06-20 15:32:54.000000000","message":"Aye, I don\u0027t know how\u0027d you poll for this but, for me anyway, reference seems like a better fit","commit_id":"3f8d16fc882ad3c0a847ed0c2377fe2800fc4164"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"4e71457827c65b364c0ab0c91e7f742fbd5811e5","unresolved":false,"context_lines":[{"line_number":74,"context_line":"    them sensibly"},{"line_number":75,"context_line":"  * ``cli/`` -- anything having to do with using command line tools"},{"line_number":76,"context_line":"  * ``admin/`` -- any admin guide content"},{"line_number":77,"context_line":"  * ``library/`` -- any reference and user information associated with"},{"line_number":78,"context_line":"    a library that is not covered by one of the above categories"},{"line_number":79,"context_line":"  * ``user/`` -- end-user content that doesn\u0027t fit into the other"},{"line_number":80,"context_line":"    sections (concept guides, advice, etc.)"}],"source_content_type":"text/x-rst","patch_set":8,"id":"5f201791_41eba5af","line":77,"range":{"start_line":77,"start_character":6,"end_line":77,"end_character":13},"in_reply_to":"5f201791_6418f4d2","updated":"2017-06-20 17:07:53.000000000","message":"Done","commit_id":"3f8d16fc882ad3c0a847ed0c2377fe2800fc4164"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"443e718ccb2e349be986ca84541d351a03a57f38","unresolved":false,"context_lines":[{"line_number":74,"context_line":"    them sensibly"},{"line_number":75,"context_line":"  * ``cli/`` -- anything having to do with using command line tools"},{"line_number":76,"context_line":"  * ``admin/`` -- any admin guide content"},{"line_number":77,"context_line":"  * ``library/`` -- any reference and user information associated with"},{"line_number":78,"context_line":"    a library that is not covered by one of the above categories"},{"line_number":79,"context_line":"  * ``user/`` -- end-user content that doesn\u0027t fit into the other"},{"line_number":80,"context_line":"    sections (concept guides, advice, etc.)"}],"source_content_type":"text/x-rst","patch_set":8,"id":"5f201791_3e59edfd","line":77,"range":{"start_line":77,"start_character":6,"end_line":77,"end_character":13},"in_reply_to":"7f231b9d_98e007cf","updated":"2017-06-20 14:32:16.000000000","message":"I would like to go with what makes more sense to the user. If you feel this would be better, great.","commit_id":"3f8d16fc882ad3c0a847ed0c2377fe2800fc4164"},{"author":{"_account_id":15334,"name":"Stephen Finucane","display_name":"stephenfin","email":"stephenfin@redhat.com","username":"sfinucan"},"change_message_id":"cd9ff81e07a3035aff0819dad43fb3ec3d9d36ae","unresolved":false,"context_lines":[{"line_number":103,"context_line":"   ``releasenotes/`` directories is deferred until we are farther"},{"line_number":104,"context_line":"   along with the initial migration work."},{"line_number":105,"context_line":""},{"line_number":106,"context_line":"A new documentation build job will be set up to take the output produced from"},{"line_number":107,"context_line":"``tox -e venv -- python setup.py build_sphinx`` (matching the existing"},{"line_number":108,"context_line":"`Consistent Testing Interface\""},{"line_number":109,"context_line":"\u003chttps://governance.openstack.org/tc/reference/project-testing-interface.html\u003e`_)"},{"line_number":110,"context_line":"and publish it to a new location under `\u003chttp://docs.openstack.org\u003e`_"},{"line_number":111,"context_line":"The results will go to:"},{"line_number":112,"context_line":""},{"line_number":113,"context_line":"* ``docs.openstack.org/$project-name/latest`` -- build from master"},{"line_number":114,"context_line":"* ``docs.openstack.org/$project-name/$series`` -- build from"}],"source_content_type":"text/x-rst","patch_set":8,"id":"7f231b9d_383d732c","line":111,"range":{"start_line":106,"start_character":0,"end_line":111,"end_character":23},"updated":"2017-06-20 08:46:39.000000000","message":"Wait - so this suggests that we\u0027re going to have one giant Sphinx project with a single \u0027conf.py\u0027 in \u0027documentation/source\u0027, as opposed to multiple projects in the  directory (like we have for \u0027openstack-manuals\u0027 today)? Could do with clarifying this above, if so","commit_id":"3f8d16fc882ad3c0a847ed0c2377fe2800fc4164"},{"author":{"_account_id":15334,"name":"Stephen Finucane","display_name":"stephenfin","email":"stephenfin@redhat.com","username":"sfinucan"},"change_message_id":"ee04d6740e62b58ff8271a0818aaf707b519e481","unresolved":false,"context_lines":[{"line_number":103,"context_line":"   ``releasenotes/`` directories is deferred until we are farther"},{"line_number":104,"context_line":"   along with the initial migration work."},{"line_number":105,"context_line":""},{"line_number":106,"context_line":"A new documentation build job will be set up to take the output produced from"},{"line_number":107,"context_line":"``tox -e venv -- python setup.py build_sphinx`` (matching the existing"},{"line_number":108,"context_line":"`Consistent Testing Interface\""},{"line_number":109,"context_line":"\u003chttps://governance.openstack.org/tc/reference/project-testing-interface.html\u003e`_)"},{"line_number":110,"context_line":"and publish it to a new location under `\u003chttp://docs.openstack.org\u003e`_"},{"line_number":111,"context_line":"The results will go to:"},{"line_number":112,"context_line":""},{"line_number":113,"context_line":"* ``docs.openstack.org/$project-name/latest`` -- build from master"},{"line_number":114,"context_line":"* ``docs.openstack.org/$project-name/$series`` -- build from"}],"source_content_type":"text/x-rst","patch_set":8,"id":"5f201791_a44bacae","line":111,"range":{"start_line":106,"start_character":0,"end_line":111,"end_character":23},"in_reply_to":"5f201791_5ed70925","updated":"2017-06-20 15:32:54.000000000","message":"I read this a few times this morning, yet when I re-read it now, I spotted that we state \"a single sphinx conf.py\" in the first paragraph of this section. Call it what you will, but you can ignore me here","commit_id":"3f8d16fc882ad3c0a847ed0c2377fe2800fc4164"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"443e718ccb2e349be986ca84541d351a03a57f38","unresolved":false,"context_lines":[{"line_number":103,"context_line":"   ``releasenotes/`` directories is deferred until we are farther"},{"line_number":104,"context_line":"   along with the initial migration work."},{"line_number":105,"context_line":""},{"line_number":106,"context_line":"A new documentation build job will be set up to take the output produced from"},{"line_number":107,"context_line":"``tox -e venv -- python setup.py build_sphinx`` (matching the existing"},{"line_number":108,"context_line":"`Consistent Testing Interface\""},{"line_number":109,"context_line":"\u003chttps://governance.openstack.org/tc/reference/project-testing-interface.html\u003e`_)"},{"line_number":110,"context_line":"and publish it to a new location under `\u003chttp://docs.openstack.org\u003e`_"},{"line_number":111,"context_line":"The results will go to:"},{"line_number":112,"context_line":""},{"line_number":113,"context_line":"* ``docs.openstack.org/$project-name/latest`` -- build from master"},{"line_number":114,"context_line":"* ``docs.openstack.org/$project-name/$series`` -- build from"}],"source_content_type":"text/x-rst","patch_set":8,"id":"5f201791_5ed70925","line":111,"range":{"start_line":106,"start_character":0,"end_line":111,"end_character":23},"in_reply_to":"7f231b9d_383d732c","updated":"2017-06-20 14:32:16.000000000","message":"Fair enough","commit_id":"3f8d16fc882ad3c0a847ed0c2377fe2800fc4164"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"7455716aaa2a050243d61113b3ce6913a51f7d1f","unresolved":false,"context_lines":[{"line_number":103,"context_line":"   ``releasenotes/`` directories is deferred until we are farther"},{"line_number":104,"context_line":"   along with the initial migration work."},{"line_number":105,"context_line":""},{"line_number":106,"context_line":"A new documentation build job will be set up to take the output produced from"},{"line_number":107,"context_line":"``tox -e venv -- python setup.py build_sphinx`` (matching the existing"},{"line_number":108,"context_line":"`Consistent Testing Interface\""},{"line_number":109,"context_line":"\u003chttps://governance.openstack.org/tc/reference/project-testing-interface.html\u003e`_)"},{"line_number":110,"context_line":"and publish it to a new location under `\u003chttp://docs.openstack.org\u003e`_"},{"line_number":111,"context_line":"The results will go to:"},{"line_number":112,"context_line":""},{"line_number":113,"context_line":"* ``docs.openstack.org/$project-name/latest`` -- build from master"},{"line_number":114,"context_line":"* ``docs.openstack.org/$project-name/$series`` -- build from"}],"source_content_type":"text/x-rst","patch_set":8,"id":"5f201791_fbcee781","line":111,"range":{"start_line":106,"start_character":0,"end_line":111,"end_character":23},"in_reply_to":"7f231b9d_383d732c","updated":"2017-06-20 14:09:12.000000000","message":"I would be happy to add or change specific wording if you have them.","commit_id":"3f8d16fc882ad3c0a847ed0c2377fe2800fc4164"},{"author":{"_account_id":15334,"name":"Stephen Finucane","display_name":"stephenfin","email":"stephenfin@redhat.com","username":"sfinucan"},"change_message_id":"cd9ff81e07a3035aff0819dad43fb3ec3d9d36ae","unresolved":false,"context_lines":[{"line_number":127,"context_line":"and move all of the existing documentation under the new structure. We will"},{"line_number":128,"context_line":"retain landing pages for the high level categories such as the install guides,"},{"line_number":129,"context_line":"the configuration reference, and contributor documentation. Those pages will"},{"line_number":130,"context_line":"continue to be mainted by the documentation team, and will deep-link into"},{"line_number":131,"context_line":"the project team documentation."},{"line_number":132,"context_line":""},{"line_number":133,"context_line":"For example, we will keep pages like"}],"source_content_type":"text/x-rst","patch_set":8,"id":"7f231b9d_382333c1","line":130,"range":{"start_line":130,"start_character":15,"end_line":130,"end_character":22},"updated":"2017-06-20 08:46:39.000000000","message":"maintained","commit_id":"3f8d16fc882ad3c0a847ed0c2377fe2800fc4164"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"4e71457827c65b364c0ab0c91e7f742fbd5811e5","unresolved":false,"context_lines":[{"line_number":127,"context_line":"and move all of the existing documentation under the new structure. We will"},{"line_number":128,"context_line":"retain landing pages for the high level categories such as the install guides,"},{"line_number":129,"context_line":"the configuration reference, and contributor documentation. Those pages will"},{"line_number":130,"context_line":"continue to be mainted by the documentation team, and will deep-link into"},{"line_number":131,"context_line":"the project team documentation."},{"line_number":132,"context_line":""},{"line_number":133,"context_line":"For example, we will keep pages like"}],"source_content_type":"text/x-rst","patch_set":8,"id":"5f201791_4104c57b","line":130,"range":{"start_line":130,"start_character":15,"end_line":130,"end_character":22},"in_reply_to":"5f201791_1ee191ff","updated":"2017-06-20 17:07:53.000000000","message":"Done","commit_id":"3f8d16fc882ad3c0a847ed0c2377fe2800fc4164"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"443e718ccb2e349be986ca84541d351a03a57f38","unresolved":false,"context_lines":[{"line_number":127,"context_line":"and move all of the existing documentation under the new structure. We will"},{"line_number":128,"context_line":"retain landing pages for the high level categories such as the install guides,"},{"line_number":129,"context_line":"the configuration reference, and contributor documentation. Those pages will"},{"line_number":130,"context_line":"continue to be mainted by the documentation team, and will deep-link into"},{"line_number":131,"context_line":"the project team documentation."},{"line_number":132,"context_line":""},{"line_number":133,"context_line":"For example, we will keep pages like"}],"source_content_type":"text/x-rst","patch_set":8,"id":"5f201791_1ee191ff","line":130,"range":{"start_line":130,"start_character":15,"end_line":130,"end_character":22},"in_reply_to":"7f231b9d_382333c1","updated":"2017-06-20 14:32:16.000000000","message":"No! :p","commit_id":"3f8d16fc882ad3c0a847ed0c2377fe2800fc4164"},{"author":{"_account_id":15334,"name":"Stephen Finucane","display_name":"stephenfin","email":"stephenfin@redhat.com","username":"sfinucan"},"change_message_id":"8390958afd86c73fe9b99914a9765704dbbf4bfb","unresolved":false,"context_lines":[{"line_number":64,"context_line":""},{"line_number":65,"context_line":"  * ``install/`` -- anything having to do with installation of the"},{"line_number":66,"context_line":"    project"},{"line_number":67,"context_line":"  * ``contributor/`` -- anything having to do with contributing to the"},{"line_number":68,"context_line":"    project (applies to most of the current content under /developer,"},{"line_number":69,"context_line":"    but not all contributors are developers and \"developer\" can be"},{"line_number":70,"context_line":"    interpreted as \"contributor\" and \"user of this library\")"}],"source_content_type":"text/x-rst","patch_set":11,"id":"5f201791_c8269bb8","line":67,"range":{"start_line":67,"start_character":6,"end_line":67,"end_character":17},"updated":"2017-06-21 13:29:03.000000000","message":"Django use \u0027internals\u0027 [1] for this (i.e. project internals), which allows them to also include information about things like how their versioning and security policies, where you can find their mailing lists, etc. This might make more sense, as much of this information is valuable to non-contributors?\n\n[1] https://docs.djangoproject.com/en/dev/internals/","commit_id":"e043dfb12fd45143bc8500f36d22f4dbab29c35a"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"66679877448892bc2291ebf59b26e0ad5cf48279","unresolved":false,"context_lines":[{"line_number":64,"context_line":""},{"line_number":65,"context_line":"  * ``install/`` -- anything having to do with installation of the"},{"line_number":66,"context_line":"    project"},{"line_number":67,"context_line":"  * ``contributor/`` -- anything having to do with contributing to the"},{"line_number":68,"context_line":"    project (applies to most of the current content under /developer,"},{"line_number":69,"context_line":"    but not all contributors are developers and \"developer\" can be"},{"line_number":70,"context_line":"    interpreted as \"contributor\" and \"user of this library\")"}],"source_content_type":"text/x-rst","patch_set":11,"id":"5f201791_f35b8c84","line":67,"range":{"start_line":67,"start_character":6,"end_line":67,"end_character":17},"in_reply_to":"5f201791_c8269bb8","updated":"2017-06-21 13:42:13.000000000","message":"I expect this section to also include things like patch formatting guidelines, hacking rule details, and the sorts of things that a contributor needs but that are not part of the code itself.","commit_id":"e043dfb12fd45143bc8500f36d22f4dbab29c35a"},{"author":{"_account_id":15334,"name":"Stephen Finucane","display_name":"stephenfin","email":"stephenfin@redhat.com","username":"sfinucan"},"change_message_id":"8390958afd86c73fe9b99914a9765704dbbf4bfb","unresolved":false,"context_lines":[{"line_number":68,"context_line":"    project (applies to most of the current content under /developer,"},{"line_number":69,"context_line":"    but not all contributors are developers and \"developer\" can be"},{"line_number":70,"context_line":"    interpreted as \"contributor\" and \"user of this library\")"},{"line_number":71,"context_line":"  * ``configuration/`` -- automatically generated (we hope)"},{"line_number":72,"context_line":"    configuration reference information as well as (we further hope)"},{"line_number":73,"context_line":"    prose explaining what all of those options mean and how to use"},{"line_number":74,"context_line":"    them sensibly"},{"line_number":75,"context_line":"  * ``cli/`` -- anything having to do with using command line tools"},{"line_number":76,"context_line":"    (auto-generated reference info, hand-written tutorials,"},{"line_number":77,"context_line":"    etc.). Because the documentation for each project should live in"}],"source_content_type":"text/x-rst","patch_set":11,"id":"5f201791_33ffc402","line":74,"range":{"start_line":71,"start_character":0,"end_line":74,"end_character":17},"updated":"2017-06-21 13:29:03.000000000","message":"So there are two types of information in this section. The first is autogenerated using a tool for openstack-doc-tools, which does a Doxygen-like automated generation of documentation. The other is handwritten, and reads like a usage guide on configuring X.\n\nI\u0027m imagining these are combined for legacy reason - config-reference and admin-guide are not only maintained by different folks, but they\u0027re completely different builds/sphinx projects that aren\u0027t truly cross-referenceable. Now, neither of these conditions if true anymore, and I wonder if it\u0027s worth keeping this a separate section or if we could make take advantage of that natural distinction. As such, I feel the autogenerated stuff would be better served placed in the reference section, while the rest would be placed in \u0027usage\u0027.","commit_id":"e043dfb12fd45143bc8500f36d22f4dbab29c35a"},{"author":{"_account_id":15334,"name":"Stephen Finucane","display_name":"stephenfin","email":"stephenfin@redhat.com","username":"sfinucan"},"change_message_id":"8390958afd86c73fe9b99914a9765704dbbf4bfb","unresolved":false,"context_lines":[{"line_number":72,"context_line":"    configuration reference information as well as (we further hope)"},{"line_number":73,"context_line":"    prose explaining what all of those options mean and how to use"},{"line_number":74,"context_line":"    them sensibly"},{"line_number":75,"context_line":"  * ``cli/`` -- anything having to do with using command line tools"},{"line_number":76,"context_line":"    (auto-generated reference info, hand-written tutorials,"},{"line_number":77,"context_line":"    etc.). Because the documentation for each project should live in"},{"line_number":78,"context_line":"    the repository with the code, this directory may not be present"},{"line_number":79,"context_line":"    for all service repositories but will be present for most of the"},{"line_number":80,"context_line":"    client library repositories."},{"line_number":81,"context_line":"  * ``admin/`` -- any admin guide content"},{"line_number":82,"context_line":"  * ``reference/`` -- any reference information associated with a"},{"line_number":83,"context_line":"    project that is not covered by one of the above categories"}],"source_content_type":"text/x-rst","patch_set":11,"id":"5f201791_8dae752c","line":80,"range":{"start_line":75,"start_character":0,"end_line":80,"end_character":32},"updated":"2017-06-21 13:29:03.000000000","message":"Similarly to \u0027configuration\u0027 above, I\u0027m not sure this makes sense. In the context of a client library, this information should really be contained in the \"users guide\" (after all, that is the main way one would \"use\" said library). Similarly, for applications like nova, you would be better off detailing the use of a utilities like nova-manage in the context of an operation, which in turns suggests usage/admin section docs. Like \u0027configuration\u0027 above, I wonder if we could simply drop this and encourage people to use, for example, a \u0027man\u0027 subdirectory in reference (we could codify that?) for the plain old reference docs, and put everything else into the users guide?","commit_id":"e043dfb12fd45143bc8500f36d22f4dbab29c35a"},{"author":{"_account_id":15334,"name":"Stephen Finucane","display_name":"stephenfin","email":"stephenfin@redhat.com","username":"sfinucan"},"change_message_id":"8390958afd86c73fe9b99914a9765704dbbf4bfb","unresolved":false,"context_lines":[{"line_number":81,"context_line":"  * ``admin/`` -- any admin guide content"},{"line_number":82,"context_line":"  * ``reference/`` -- any reference information associated with a"},{"line_number":83,"context_line":"    project that is not covered by one of the above categories"},{"line_number":84,"context_line":"  * ``user/`` -- end-user content that doesn\u0027t fit into the other"},{"line_number":85,"context_line":"    sections (concept guides, advice, etc.)"},{"line_number":86,"context_line":""},{"line_number":87,"context_line":"This layout is the *minimum* set. Projects are free and encouraged to"},{"line_number":88,"context_line":"add whatever other docs they need beyond this list, but these items"}],"source_content_type":"text/x-rst","patch_set":11,"id":"5f201791_08c13355","line":85,"range":{"start_line":84,"start_character":0,"end_line":85,"end_character":43},"updated":"2017-06-21 13:29:03.000000000","message":"Could this be combined with the \u0027admin\u0027 section above and potentially be renamed \u0027usage\u0027? The \u0027reference\u0027 section should include things like concepts guides etc., while advice should be included in either the usage guide or contributors guide, depending on the target audience. I feel that by keeping this around, it\u0027ll turn into a dumping ground that\u0027ll be extremely inconsistent use of these sections among different projects.","commit_id":"e043dfb12fd45143bc8500f36d22f4dbab29c35a"},{"author":{"_account_id":2750,"name":"Sean Dague","email":"sean@dague.net","username":"sdague"},"change_message_id":"b82df6339265aa7f2f0a055fd41dbae40e9ab593","unresolved":false,"context_lines":[{"line_number":111,"context_line":""},{"line_number":112,"context_line":"* ``doc/source/``"},{"line_number":113,"context_line":""},{"line_number":114,"context_line":"  * ``api/`` -- the REST API reference and Guide content, when it exists"},{"line_number":115,"context_line":"  * ``releasenotes/`` -- reno directions (the actual release notes"},{"line_number":116,"context_line":"    inputs will stay in /releasenotes/notes, where they are now)"},{"line_number":117,"context_line":""}],"source_content_type":"text/x-rst","patch_set":13,"id":"9f436f4f_dbe0a999","line":114,"updated":"2017-08-08 16:42:23.000000000","message":"I apologize for not reviewing when this was up for review. However I don\u0027t think it makes sense to put the api docs into here.\n\nThe content in doc/source is specifically branch versioned (like the install guide). That\u0027s only appropriate for some of the documentation. Some of it requires that there are not branches (like api-ref) as the api-ref should cover the entire API for a project.\n\nThere was also a very specific piece of feedback that having developer.openstack.org as the top level landing page was critical to Developer Experience. While I did not agree with it at the time, it was accepted. Moving api-ref without explicitly stating the expected migration path for that site seems to be missing some critical steps.","commit_id":"f0fe465f695ff7b4c1a246a07eae877746928e46"},{"author":{"_account_id":6873,"name":"Matt Riedemann","email":"mriedem.os@gmail.com","username":"mriedem"},"change_message_id":"63d832250fc79c2738f1f63b85d444e2d05e351d","unresolved":false,"context_lines":[{"line_number":243,"context_line":"    python-glanceclient repository."},{"line_number":244,"context_line":""},{"line_number":245,"context_line":"* Virtual Machine Image Reference"},{"line_number":246,"context_line":"  * This content will stay in openstack-manuals."},{"line_number":247,"context_line":""},{"line_number":248,"context_line":"Migration process"},{"line_number":249,"context_line":"-----------------"}],"source_content_type":"text/x-rst","patch_set":13,"id":"5f201791_636e3c96","line":246,"updated":"2017-06-23 16:13:44.000000000","message":"tsk tsk you need a blank line between the bullets for it to format properly.","commit_id":"f0fe465f695ff7b4c1a246a07eae877746928e46"},{"author":{"_account_id":11536,"name":"hongbin","email":"hongbin034@gmail.com","username":"hongbin"},"change_message_id":"1b43fee2a16ff5594bfd09c074e7be0df9718a1c","unresolved":false,"context_lines":[{"line_number":281,"context_line":"#. Ensure that there is a top-level index.rst in doc/source that"},{"line_number":282,"context_line":"   incorporates all of the documentation for the project by including"},{"line_number":283,"context_line":"   all of the subdirectories in a toctree."},{"line_number":284,"context_line":"#. Update the theme for the in-tree docs to use the openstackdocstheme"},{"line_number":285,"context_line":"   instead of oslosphinx."},{"line_number":286,"context_line":"#. Add auto-generated config reference section(s)."},{"line_number":287,"context_line":"#. If pbr\u0027s autodoc feature is being used, update the ``api_doc_dir``"}],"source_content_type":"text/x-rst","patch_set":13,"id":"5f201791_9f7b0dbd","line":284,"range":{"start_line":284,"start_character":44,"end_line":284,"end_character":70},"updated":"2017-06-22 18:54:44.000000000","message":"Would be helpful to include a link to an instruction (if any) about how to do this.","commit_id":"f0fe465f695ff7b4c1a246a07eae877746928e46"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"2d4063fdf7c6c8f67d302711eb620fa262e40ab8","unresolved":false,"context_lines":[{"line_number":281,"context_line":"#. Ensure that there is a top-level index.rst in doc/source that"},{"line_number":282,"context_line":"   incorporates all of the documentation for the project by including"},{"line_number":283,"context_line":"   all of the subdirectories in a toctree."},{"line_number":284,"context_line":"#. Update the theme for the in-tree docs to use the openstackdocstheme"},{"line_number":285,"context_line":"   instead of oslosphinx."},{"line_number":286,"context_line":"#. Add auto-generated config reference section(s)."},{"line_number":287,"context_line":"#. If pbr\u0027s autodoc feature is being used, update the ``api_doc_dir``"}],"source_content_type":"text/x-rst","patch_set":13,"id":"5f201791_9abafb07","line":284,"range":{"start_line":284,"start_character":44,"end_line":284,"end_character":70},"in_reply_to":"5f201791_9f7b0dbd","updated":"2017-06-22 19:04:24.000000000","message":"Good point. There are some examples up already using the same doc-migration topic. Here\u0027s a recent one: https://review.openstack.org/#/c/476659/","commit_id":"f0fe465f695ff7b4c1a246a07eae877746928e46"},{"author":{"_account_id":11536,"name":"hongbin","email":"hongbin034@gmail.com","username":"hongbin"},"change_message_id":"1b43fee2a16ff5594bfd09c074e7be0df9718a1c","unresolved":false,"context_lines":[{"line_number":283,"context_line":"   all of the subdirectories in a toctree."},{"line_number":284,"context_line":"#. Update the theme for the in-tree docs to use the openstackdocstheme"},{"line_number":285,"context_line":"   instead of oslosphinx."},{"line_number":286,"context_line":"#. Add auto-generated config reference section(s)."},{"line_number":287,"context_line":"#. If pbr\u0027s autodoc feature is being used, update the ``api_doc_dir``"},{"line_number":288,"context_line":"   setting in the ``pbr`` section of ``setup.cfg`` to point to either"},{"line_number":289,"context_line":"   ``reference/api`` (for libraries) or ``contributor/api`` (for other"}],"source_content_type":"text/x-rst","patch_set":13,"id":"5f201791_5f3455fb","line":286,"range":{"start_line":286,"start_character":3,"end_line":286,"end_character":49},"updated":"2017-06-22 18:54:44.000000000","message":"Not sure what this means.","commit_id":"f0fe465f695ff7b4c1a246a07eae877746928e46"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"2d4063fdf7c6c8f67d302711eb620fa262e40ab8","unresolved":false,"context_lines":[{"line_number":283,"context_line":"   all of the subdirectories in a toctree."},{"line_number":284,"context_line":"#. Update the theme for the in-tree docs to use the openstackdocstheme"},{"line_number":285,"context_line":"   instead of oslosphinx."},{"line_number":286,"context_line":"#. Add auto-generated config reference section(s)."},{"line_number":287,"context_line":"#. If pbr\u0027s autodoc feature is being used, update the ``api_doc_dir``"},{"line_number":288,"context_line":"   setting in the ``pbr`` section of ``setup.cfg`` to point to either"},{"line_number":289,"context_line":"   ``reference/api`` (for libraries) or ``contributor/api`` (for other"}],"source_content_type":"text/x-rst","patch_set":13,"id":"5f201791_fa4a0f25","line":286,"range":{"start_line":286,"start_character":3,"end_line":286,"end_character":49},"in_reply_to":"5f201791_5f3455fb","updated":"2017-06-22 19:04:24.000000000","message":"Using https://docs.openstack.org/developer/oslo.config/sphinxext.html to generate a configuration reference guide. Glance has one in their docs already.","commit_id":"f0fe465f695ff7b4c1a246a07eae877746928e46"},{"author":{"_account_id":6873,"name":"Matt Riedemann","email":"mriedem.os@gmail.com","username":"mriedem"},"change_message_id":"63d832250fc79c2738f1f63b85d444e2d05e351d","unresolved":false,"context_lines":[{"line_number":283,"context_line":"   all of the subdirectories in a toctree."},{"line_number":284,"context_line":"#. Update the theme for the in-tree docs to use the openstackdocstheme"},{"line_number":285,"context_line":"   instead of oslosphinx."},{"line_number":286,"context_line":"#. Add auto-generated config reference section(s)."},{"line_number":287,"context_line":"#. If pbr\u0027s autodoc feature is being used, update the ``api_doc_dir``"},{"line_number":288,"context_line":"   setting in the ``pbr`` section of ``setup.cfg`` to point to either"},{"line_number":289,"context_line":"   ``reference/api`` (for libraries) or ``contributor/api`` (for other"}],"source_content_type":"text/x-rst","patch_set":13,"id":"5f201791_e3e7ece3","line":286,"range":{"start_line":286,"start_character":3,"end_line":286,"end_character":49},"in_reply_to":"5f201791_fa4a0f25","updated":"2017-06-23 16:13:44.000000000","message":"Nova has one too:\n\nhttps://docs.openstack.org/developer/nova/sample_config.html\n\nhttps://github.com/openstack/nova/blob/master/doc/source/conf.py#L36\n\nhttps://github.com/openstack/nova/blob/master/doc/source/conf.py#L42\n\nhttps://github.com/openstack/nova/blob/master/etc/nova/nova-config-generator.conf","commit_id":"f0fe465f695ff7b4c1a246a07eae877746928e46"},{"author":{"_account_id":5263,"name":"Jeremy Stanley","display_name":"fungi","email":"fungi@yuggoth.org","username":"fungi","status":"missing, presumed fed"},"change_message_id":"bed438050a40f1944b368fe6b2102ef101faefca","unresolved":false,"context_lines":[{"line_number":304,"context_line":"   ``openstack-manuals/www/static/.htaccess``. For example,"},{"line_number":305,"context_line":"   ``/compute`` should redirect to ``/nova``."},{"line_number":306,"context_line":"#. After project-specific install guides are moved into the doc tree,"},{"line_number":307,"context_line":"   set up a 302 redirect rule from /project-install-guide to the"},{"line_number":308,"context_line":"   new /install location by editing"},{"line_number":309,"context_line":"   ``openstack-manuals/www/static/.htaccess``."},{"line_number":310,"context_line":"#. Update the main landing page(s) starting with docs.o.o/ (see notes above)"}],"source_content_type":"text/x-rst","patch_set":13,"id":"5f201791_1635c846","line":307,"updated":"2017-06-21 22:23:53.000000000","message":"This one could probably stand to be a 301, but we can always decide to optimize that later.","commit_id":"f0fe465f695ff7b4c1a246a07eae877746928e46"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"19976c41c9dfc9c5c6a8108983ddf18bb803af66","unresolved":false,"context_lines":[{"line_number":304,"context_line":"   ``openstack-manuals/www/static/.htaccess``. For example,"},{"line_number":305,"context_line":"   ``/compute`` should redirect to ``/nova``."},{"line_number":306,"context_line":"#. After project-specific install guides are moved into the doc tree,"},{"line_number":307,"context_line":"   set up a 302 redirect rule from /project-install-guide to the"},{"line_number":308,"context_line":"   new /install location by editing"},{"line_number":309,"context_line":"   ``openstack-manuals/www/static/.htaccess``."},{"line_number":310,"context_line":"#. Update the main landing page(s) starting with docs.o.o/ (see notes above)"}],"source_content_type":"text/x-rst","patch_set":13,"id":"5f201791_f1835aa8","line":307,"in_reply_to":"5f201791_1635c846","updated":"2017-06-22 17:32:18.000000000","message":"It turns out I was able to do this in one patch using a template. I will propose an update to this spec after we approve it to remove this step.","commit_id":"f0fe465f695ff7b4c1a246a07eae877746928e46"}]}