)]}'
{"specs/newton/project-specific-installguides.rst":[{"author":{"_account_id":964,"name":"Anne Gentle","email":"annegentle@justwriteclick.com","username":"annegentle"},"change_message_id":"d30591168bf118e04b502ec5b39be51feba095c0","unresolved":false,"context_lines":[{"line_number":11,"context_line":"Problem description"},{"line_number":12,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":13,"context_line":""},{"line_number":14,"context_line":"With the growing OpenStack Big Tent, many projects like to create"},{"line_number":15,"context_line":"Install Guides. The current Install Guide is concentrating on a small"},{"line_number":16,"context_line":"set of projects and gets tested each release. Documenting and testing"},{"line_number":17,"context_line":"all projects in the Install Guide is not possible with the current"}],"source_content_type":"text/x-rst","patch_set":1,"id":"9a061dce_a2a58405","line":14,"updated":"2016-04-04 18:51:52.000000000","message":"need to create","commit_id":"e5a93d4da69e531ff90e39c7d00e4b39094ed678"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"2ffa8754d8bb7d35c8c749a56cf3dfcece9581cd","unresolved":false,"context_lines":[{"line_number":11,"context_line":"Problem description"},{"line_number":12,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":13,"context_line":""},{"line_number":14,"context_line":"With the growing OpenStack Big Tent, many projects like to create"},{"line_number":15,"context_line":"Install Guides. The current Install Guide is concentrating on a small"},{"line_number":16,"context_line":"set of projects and gets tested each release. Documenting and testing"},{"line_number":17,"context_line":"all projects in the Install Guide is not possible with the current"}],"source_content_type":"text/x-rst","patch_set":1,"id":"9a061dce_f1ce1559","line":14,"in_reply_to":"9a061dce_a2a58405","updated":"2016-04-05 07:08:09.000000000","message":"Done","commit_id":"e5a93d4da69e531ff90e39c7d00e4b39094ed678"},{"author":{"_account_id":964,"name":"Anne Gentle","email":"annegentle@justwriteclick.com","username":"annegentle"},"change_message_id":"d30591168bf118e04b502ec5b39be51feba095c0","unresolved":false,"context_lines":[{"line_number":29,"context_line":"Install Guide will cover the core base projects only: Compute service,"},{"line_number":30,"context_line":"Identity service, Networking service, Image service, Block Storage"},{"line_number":31,"context_line":"service, Object Storage service, Telemetry service, and Orchestration"},{"line_number":32,"context_line":"service."},{"line_number":33,"context_line":""},{"line_number":34,"context_line":"The documentation team will update and test the guide for each"},{"line_number":35,"context_line":"release."}],"source_content_type":"text/x-rst","patch_set":1,"id":"9a061dce_42a628c2","line":32,"updated":"2016-04-04 18:51:52.000000000","message":"I could see it as a re-title also to make sure people understand the goals of this opinionated Install Guide. Ideas? \"Infra base layer install guide or training guide?\"\n\nI\u0027d drop the last three services because they\u0027re not \"infrastructure\" and Telemetry and Orchestration require Compute I believe. Object Storage has always been hard to classify. But it\u0027s okay to call them infrastructure I believe.\n\nOne other questionable inclusion is the Dashboard. Might be easier for the horizon team to review their own content anyway.","commit_id":"e5a93d4da69e531ff90e39c7d00e4b39094ed678"},{"author":{"_account_id":964,"name":"Anne Gentle","email":"annegentle@justwriteclick.com","username":"annegentle"},"change_message_id":"d30591168bf118e04b502ec5b39be51feba095c0","unresolved":false,"context_lines":[{"line_number":32,"context_line":"service."},{"line_number":33,"context_line":""},{"line_number":34,"context_line":"The documentation team will update and test the guide for each"},{"line_number":35,"context_line":"release."},{"line_number":36,"context_line":""},{"line_number":37,"context_line":"No further projects will be added to the guide unless they are"},{"line_number":38,"context_line":"required by one of the existing projects or generally required to run"}],"source_content_type":"text/x-rst","patch_set":1,"id":"9a061dce_c2923857","line":35,"updated":"2016-04-04 18:51:52.000000000","message":"Are you proposing that doc team members propose the initial patches to say heat, horizon, trove? Might be good to find task owners early.","commit_id":"e5a93d4da69e531ff90e39c7d00e4b39094ed678"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"e3362889d73d98b8693aa642b85cf9149925db60","unresolved":false,"context_lines":[{"line_number":32,"context_line":"service."},{"line_number":33,"context_line":""},{"line_number":34,"context_line":"The documentation team will update and test the guide for each"},{"line_number":35,"context_line":"release."},{"line_number":36,"context_line":""},{"line_number":37,"context_line":"No further projects will be added to the guide unless they are"},{"line_number":38,"context_line":"required by one of the existing projects or generally required to run"}],"source_content_type":"text/x-rst","patch_set":1,"id":"9a061dce_82a4c057","line":35,"in_reply_to":"9a061dce_c2923857","updated":"2016-04-04 19:04:56.000000000","message":"I think he\u0027s referring to the core services. However, I propose that these projects commit resources to assisting the documentation team with changes and testing.","commit_id":"e5a93d4da69e531ff90e39c7d00e4b39094ed678"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"e3362889d73d98b8693aa642b85cf9149925db60","unresolved":false,"context_lines":[{"line_number":36,"context_line":""},{"line_number":37,"context_line":"No further projects will be added to the guide unless they are"},{"line_number":38,"context_line":"required by one of the existing projects or generally required to run"},{"line_number":39,"context_line":"an OpenStack based cloud."},{"line_number":40,"context_line":""},{"line_number":41,"context_line":"Since OpenStack has grown and contains many more projects, the"},{"line_number":42,"context_line":"documentation team will concentrate on the core projects in the"}],"source_content_type":"text/x-rst","patch_set":1,"id":"9a061dce_02a8b01e","line":39,"updated":"2016-04-04 19:04:56.000000000","message":"I think we need to review the definition of core after adopting the big tent. In theory, you only need keystone, glance, nova, and neutron to launch an instance.","commit_id":"e5a93d4da69e531ff90e39c7d00e4b39094ed678"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"2ffa8754d8bb7d35c8c749a56cf3dfcece9581cd","unresolved":false,"context_lines":[{"line_number":36,"context_line":""},{"line_number":37,"context_line":"No further projects will be added to the guide unless they are"},{"line_number":38,"context_line":"required by one of the existing projects or generally required to run"},{"line_number":39,"context_line":"an OpenStack based cloud."},{"line_number":40,"context_line":""},{"line_number":41,"context_line":"Since OpenStack has grown and contains many more projects, the"},{"line_number":42,"context_line":"documentation team will concentrate on the core projects in the"}],"source_content_type":"text/x-rst","patch_set":1,"id":"9a061dce_b103fd72","line":39,"in_reply_to":"9a061dce_02a8b01e","updated":"2016-04-05 07:08:09.000000000","message":"Yes, that\u0027s the minimal. I\u0027ve now added in the next revision horizon and cinder as well.","commit_id":"e5a93d4da69e531ff90e39c7d00e4b39094ed678"},{"author":{"_account_id":964,"name":"Anne Gentle","email":"annegentle@justwriteclick.com","username":"annegentle"},"change_message_id":"d30591168bf118e04b502ec5b39be51feba095c0","unresolved":false,"context_lines":[{"line_number":49,"context_line":"for each official project a small section where each official project"},{"line_number":50,"context_line":"can give a short summary of their project together with a link to"},{"line_number":51,"context_line":"their own Install Guide."},{"line_number":52,"context_line":""},{"line_number":53,"context_line":"The project specific Install Guides will thus be listed on the"},{"line_number":54,"context_line":"docs.openstack.org web page and also in the Install Guide."},{"line_number":55,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"9a061dce_8287a00e","line":52,"updated":"2016-04-04 18:51:52.000000000","message":"I think this paragraph could have a for example:\n\nFor example, Orchestration could store their install guide in the heat repository, and publish to http://docs.openstack.org/install-guide/orchestration. \n\nIs that information architecture/ URL what you had in mind?","commit_id":"e5a93d4da69e531ff90e39c7d00e4b39094ed678"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"2ffa8754d8bb7d35c8c749a56cf3dfcece9581cd","unresolved":false,"context_lines":[{"line_number":49,"context_line":"for each official project a small section where each official project"},{"line_number":50,"context_line":"can give a short summary of their project together with a link to"},{"line_number":51,"context_line":"their own Install Guide."},{"line_number":52,"context_line":""},{"line_number":53,"context_line":"The project specific Install Guides will thus be listed on the"},{"line_number":54,"context_line":"docs.openstack.org web page and also in the Install Guide."},{"line_number":55,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"9a061dce_f1f57583","line":52,"in_reply_to":"9a061dce_8287a00e","updated":"2016-04-05 07:08:09.000000000","message":"Done","commit_id":"e5a93d4da69e531ff90e39c7d00e4b39094ed678"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"e3362889d73d98b8693aa642b85cf9149925db60","unresolved":false,"context_lines":[{"line_number":59,"context_line":""},{"line_number":60,"context_line":"* We encourage projects to build on top of the existing Install Guide"},{"line_number":61,"context_line":"  architecture. This way they do not need to document a full OpenStack"},{"line_number":62,"context_line":"  setup but can just point out differences for their project."},{"line_number":63,"context_line":""},{"line_number":64,"context_line":"* We encourage projects to follow the documentation conventions as"},{"line_number":65,"context_line":"  written down in the Contributor\u0027s Guide."}],"source_content_type":"text/x-rst","patch_set":1,"id":"9a061dce_8249608e","line":62,"updated":"2016-04-04 19:04:56.000000000","message":"If possible, augmenting the installation guide architecture makes sense because project won\u0027t need to \"reinvent the wheel\" of basic host configuration.","commit_id":"e5a93d4da69e531ff90e39c7d00e4b39094ed678"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"2ffa8754d8bb7d35c8c749a56cf3dfcece9581cd","unresolved":false,"context_lines":[{"line_number":59,"context_line":""},{"line_number":60,"context_line":"* We encourage projects to build on top of the existing Install Guide"},{"line_number":61,"context_line":"  architecture. This way they do not need to document a full OpenStack"},{"line_number":62,"context_line":"  setup but can just point out differences for their project."},{"line_number":63,"context_line":""},{"line_number":64,"context_line":"* We encourage projects to follow the documentation conventions as"},{"line_number":65,"context_line":"  written down in the Contributor\u0027s Guide."}],"source_content_type":"text/x-rst","patch_set":1,"id":"9a061dce_31f08d90","line":62,"in_reply_to":"9a061dce_8249608e","updated":"2016-04-05 07:08:09.000000000","message":"Agreed. That\u0027s why I put this first here. Let me emphasize this a bit more.","commit_id":"e5a93d4da69e531ff90e39c7d00e4b39094ed678"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"e3362889d73d98b8693aa642b85cf9149925db60","unresolved":false,"context_lines":[{"line_number":68,"context_line":"  openstackdocstheme) as the Install Guide."},{"line_number":69,"context_line":""},{"line_number":70,"context_line":"* We encourage projects to support the same distributions as the"},{"line_number":71,"context_line":"  Install Guide does."},{"line_number":72,"context_line":""},{"line_number":73,"context_line":""},{"line_number":74,"context_line":"Alternatives"}],"source_content_type":"text/x-rst","patch_set":1,"id":"9a061dce_e225bcc2","line":71,"updated":"2016-04-04 19:04:56.000000000","message":"Supporting distributions outside of using them as a \"base\" gets a bit sketchy because a significant number of big tent projects lack packages and we can\u0027t easily combine packages and source. One way or the other.","commit_id":"e5a93d4da69e531ff90e39c7d00e4b39094ed678"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"2ffa8754d8bb7d35c8c749a56cf3dfcece9581cd","unresolved":false,"context_lines":[{"line_number":68,"context_line":"  openstackdocstheme) as the Install Guide."},{"line_number":69,"context_line":""},{"line_number":70,"context_line":"* We encourage projects to support the same distributions as the"},{"line_number":71,"context_line":"  Install Guide does."},{"line_number":72,"context_line":""},{"line_number":73,"context_line":""},{"line_number":74,"context_line":"Alternatives"}],"source_content_type":"text/x-rst","patch_set":1,"id":"9a061dce_91c7d911","line":71,"in_reply_to":"9a061dce_e225bcc2","updated":"2016-04-05 07:08:09.000000000","message":"Enhanced, good point.","commit_id":"e5a93d4da69e531ff90e39c7d00e4b39094ed678"},{"author":{"_account_id":964,"name":"Anne Gentle","email":"annegentle@justwriteclick.com","username":"annegentle"},"change_message_id":"d30591168bf118e04b502ec5b39be51feba095c0","unresolved":false,"context_lines":[{"line_number":76,"context_line":""},{"line_number":77,"context_line":"* Keep some more projects in the guide like existing swift and manila."},{"line_number":78,"context_line":"* None that scales."},{"line_number":79,"context_line":""},{"line_number":80,"context_line":""},{"line_number":81,"context_line":""},{"line_number":82,"context_line":"Implementation"}],"source_content_type":"text/x-rst","patch_set":1,"id":"9a061dce_a2b0e4de","line":79,"updated":"2016-04-04 18:51:52.000000000","message":"One additional alternative, to make sure it\u0027s discussed. \n\n* Have each distro publish an installation guide on a web domain they own, sourced from their own repositories. Then each project could write an \"install from source\" installation guide.","commit_id":"e5a93d4da69e531ff90e39c7d00e4b39094ed678"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"e3362889d73d98b8693aa642b85cf9149925db60","unresolved":false,"context_lines":[{"line_number":76,"context_line":""},{"line_number":77,"context_line":"* Keep some more projects in the guide like existing swift and manila."},{"line_number":78,"context_line":"* None that scales."},{"line_number":79,"context_line":""},{"line_number":80,"context_line":""},{"line_number":81,"context_line":""},{"line_number":82,"context_line":"Implementation"}],"source_content_type":"text/x-rst","patch_set":1,"id":"9a061dce_8d0eb132","line":79,"in_reply_to":"9a061dce_a2b0e4de","updated":"2016-04-04 19:04:56.000000000","message":"Installing from source is all or nothing unless we add complexity such as venvs or containers.","commit_id":"e5a93d4da69e531ff90e39c7d00e4b39094ed678"},{"author":{"_account_id":964,"name":"Anne Gentle","email":"annegentle@justwriteclick.com","username":"annegentle"},"change_message_id":"d30591168bf118e04b502ec5b39be51feba095c0","unresolved":false,"context_lines":[{"line_number":82,"context_line":"Implementation"},{"line_number":83,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":84,"context_line":""},{"line_number":85,"context_line":"* Move manila, swift out of guide into their repositories."},{"line_number":86,"context_line":"* Create new chapter \"project specific Install Guides\" linking to other guides"},{"line_number":87,"context_line":"* Create new project specific Install Guides section on"},{"line_number":88,"context_line":"  http://docs.openstack.org"}],"source_content_type":"text/x-rst","patch_set":1,"id":"9a061dce_e2d13cfd","line":85,"updated":"2016-04-04 18:51:52.000000000","message":"Since you have Object Storage in above paragraphs, modify for what you mean.","commit_id":"e5a93d4da69e531ff90e39c7d00e4b39094ed678"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"2ffa8754d8bb7d35c8c749a56cf3dfcece9581cd","unresolved":false,"context_lines":[{"line_number":82,"context_line":"Implementation"},{"line_number":83,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":84,"context_line":""},{"line_number":85,"context_line":"* Move manila, swift out of guide into their repositories."},{"line_number":86,"context_line":"* Create new chapter \"project specific Install Guides\" linking to other guides"},{"line_number":87,"context_line":"* Create new project specific Install Guides section on"},{"line_number":88,"context_line":"  http://docs.openstack.org"}],"source_content_type":"text/x-rst","patch_set":1,"id":"9a061dce_d16dd105","line":85,"in_reply_to":"9a061dce_e2d13cfd","updated":"2016-04-05 07:08:09.000000000","message":"Done","commit_id":"e5a93d4da69e531ff90e39c7d00e4b39094ed678"},{"author":{"_account_id":170,"name":"Mike Perez","email":"thingee@gmail.com","username":"thingee"},"change_message_id":"46695acb5e36f57e38ccea2b8a4b6ebe676e2a14","unresolved":false,"context_lines":[{"line_number":26,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":27,"context_line":""},{"line_number":28,"context_line":""},{"line_number":29,"context_line":"Install Guide will cover the core infrastructure projects only:"},{"line_number":30,"context_line":"Compute service, Identity service, Networking service, Image service,"},{"line_number":31,"context_line":"Block Storage service, and Object Storage service."},{"line_number":32,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"9a061dce_213cc992","line":29,"updated":"2016-04-04 23:16:19.000000000","message":"Not really sure what \"core infra\" means here. One could argue your core is file level storage instead of block.","commit_id":"500852c21a81e8653cdc46c4b493ceb6b994308c"},{"author":{"_account_id":10497,"name":"KATO Tomoyuki","email":"kato.tomoyuki@jp.fujitsu.com","username":"to222"},"change_message_id":"d369420b64a5d6bc94bfd1ecbbcf7bb67e077c2f","unresolved":false,"context_lines":[{"line_number":26,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":27,"context_line":""},{"line_number":28,"context_line":""},{"line_number":29,"context_line":"Install Guide will cover the core infrastructure projects only:"},{"line_number":30,"context_line":"Compute service, Identity service, Networking service, Image service,"},{"line_number":31,"context_line":"Block Storage service, and Object Storage service."},{"line_number":32,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"9a061dce_25f97481","line":29,"in_reply_to":"9a061dce_213cc992","updated":"2016-04-04 23:52:22.000000000","message":"I\u0027d like to use the words in http://www.openstack.org/software/. i.e. \"core services installation guide\", and \"optional services installation guide\" or \"xxx service installation guide\" for each service.","commit_id":"500852c21a81e8653cdc46c4b493ceb6b994308c"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"957fd1c6b88d5b0d7733ad93a0a351ef880ce97f","unresolved":false,"context_lines":[{"line_number":26,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":27,"context_line":""},{"line_number":28,"context_line":""},{"line_number":29,"context_line":"Install Guide will cover the core infrastructure projects only:"},{"line_number":30,"context_line":"Compute service, Identity service, Networking service, Image service,"},{"line_number":31,"context_line":"Block Storage service, and Object Storage service."},{"line_number":32,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"9a061dce_d1b4b1f3","line":29,"in_reply_to":"9a061dce_25f97481","updated":"2016-04-05 06:55:47.000000000","message":"Done","commit_id":"500852c21a81e8653cdc46c4b493ceb6b994308c"},{"author":{"_account_id":10497,"name":"KATO Tomoyuki","email":"kato.tomoyuki@jp.fujitsu.com","username":"to222"},"change_message_id":"d369420b64a5d6bc94bfd1ecbbcf7bb67e077c2f","unresolved":false,"context_lines":[{"line_number":27,"context_line":""},{"line_number":28,"context_line":""},{"line_number":29,"context_line":"Install Guide will cover the core infrastructure projects only:"},{"line_number":30,"context_line":"Compute service, Identity service, Networking service, Image service,"},{"line_number":31,"context_line":"Block Storage service, and Object Storage service."},{"line_number":32,"context_line":""},{"line_number":33,"context_line":"The documentation team will update and test the guide for each"}],"source_content_type":"text/x-rst","patch_set":3,"id":"9a061dce_c58878ea","line":30,"updated":"2016-04-04 23:52:22.000000000","message":"I\u0027d like to add Dashboard (Horizon) as a special exception. I think Dashboard is a essential service to the new comers.","commit_id":"500852c21a81e8653cdc46c4b493ceb6b994308c"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"957fd1c6b88d5b0d7733ad93a0a351ef880ce97f","unresolved":false,"context_lines":[{"line_number":27,"context_line":""},{"line_number":28,"context_line":""},{"line_number":29,"context_line":"Install Guide will cover the core infrastructure projects only:"},{"line_number":30,"context_line":"Compute service, Identity service, Networking service, Image service,"},{"line_number":31,"context_line":"Block Storage service, and Object Storage service."},{"line_number":32,"context_line":""},{"line_number":33,"context_line":"The documentation team will update and test the guide for each"}],"source_content_type":"text/x-rst","patch_set":3,"id":"9a061dce_71bfa5d0","line":30,"in_reply_to":"9a061dce_c58878ea","updated":"2016-04-05 06:55:47.000000000","message":"Done","commit_id":"500852c21a81e8653cdc46c4b493ceb6b994308c"},{"author":{"_account_id":16157,"name":"Ken Johnston","email":"kenny@kencjohnston.com","username":"kencjohnston"},"change_message_id":"ca50a56921b22ea97c06a510d610deceda108d30","unresolved":false,"context_lines":[{"line_number":33,"context_line":"The documentation team will update and test the guide for each"},{"line_number":34,"context_line":"release."},{"line_number":35,"context_line":""},{"line_number":36,"context_line":"No further projects will be added to the guide unless they are"},{"line_number":37,"context_line":"required by one of the existing projects or generally required to run"},{"line_number":38,"context_line":"an OpenStack based cloud."},{"line_number":39,"context_line":""},{"line_number":40,"context_line":"Since OpenStack has grown and contains many more projects, the"},{"line_number":41,"context_line":"documentation team will concentrate on the core projects in the"}],"source_content_type":"text/x-rst","patch_set":3,"id":"9a061dce_ad0c5595","line":38,"range":{"start_line":36,"start_character":0,"end_line":38,"end_character":25},"updated":"2016-04-04 19:24:27.000000000","message":"It would seem that with this suggestion we are making a statement that by following the Install Guide you are getting an OpenStack Proof of Concept Guide, the minimum required OpenStack environment. If that is the case we should also rename the guide as such.","commit_id":"500852c21a81e8653cdc46c4b493ceb6b994308c"},{"author":{"_account_id":16157,"name":"Ken Johnston","email":"kenny@kencjohnston.com","username":"kencjohnston"},"change_message_id":"5e2d0e6782169bbad4a8a56f3886627c5cd6bbcb","unresolved":false,"context_lines":[{"line_number":33,"context_line":"The documentation team will update and test the guide for each"},{"line_number":34,"context_line":"release."},{"line_number":35,"context_line":""},{"line_number":36,"context_line":"No further projects will be added to the guide unless they are"},{"line_number":37,"context_line":"required by one of the existing projects or generally required to run"},{"line_number":38,"context_line":"an OpenStack based cloud."},{"line_number":39,"context_line":""},{"line_number":40,"context_line":"Since OpenStack has grown and contains many more projects, the"},{"line_number":41,"context_line":"documentation team will concentrate on the core projects in the"}],"source_content_type":"text/x-rst","patch_set":3,"id":"9a061dce_9ccee058","line":38,"range":{"start_line":36,"start_character":0,"end_line":38,"end_character":25},"in_reply_to":"9a061dce_1c0ad0d2","updated":"2016-04-04 19:59:08.000000000","message":"Agreed, I think we might have some overloading of the current Guide because it is called \"Install Guide\" adding a qualifier will help both with internal and external understanding of the guide\u0027s intent. This is not the place you go to install your production OpenStack.","commit_id":"500852c21a81e8653cdc46c4b493ceb6b994308c"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"957fd1c6b88d5b0d7733ad93a0a351ef880ce97f","unresolved":false,"context_lines":[{"line_number":33,"context_line":"The documentation team will update and test the guide for each"},{"line_number":34,"context_line":"release."},{"line_number":35,"context_line":""},{"line_number":36,"context_line":"No further projects will be added to the guide unless they are"},{"line_number":37,"context_line":"required by one of the existing projects or generally required to run"},{"line_number":38,"context_line":"an OpenStack based cloud."},{"line_number":39,"context_line":""},{"line_number":40,"context_line":"Since OpenStack has grown and contains many more projects, the"},{"line_number":41,"context_line":"documentation team will concentrate on the core projects in the"}],"source_content_type":"text/x-rst","patch_set":3,"id":"9a061dce_31efede9","line":38,"range":{"start_line":36,"start_character":0,"end_line":38,"end_character":25},"in_reply_to":"9a061dce_615d21e9","updated":"2016-04-05 06:55:47.000000000","message":"Thanks, for starter-kit hint. I\u0027ll add a few more services and also explain a bit why they are in.","commit_id":"500852c21a81e8653cdc46c4b493ceb6b994308c"},{"author":{"_account_id":170,"name":"Mike Perez","email":"thingee@gmail.com","username":"thingee"},"change_message_id":"46695acb5e36f57e38ccea2b8a4b6ebe676e2a14","unresolved":false,"context_lines":[{"line_number":33,"context_line":"The documentation team will update and test the guide for each"},{"line_number":34,"context_line":"release."},{"line_number":35,"context_line":""},{"line_number":36,"context_line":"No further projects will be added to the guide unless they are"},{"line_number":37,"context_line":"required by one of the existing projects or generally required to run"},{"line_number":38,"context_line":"an OpenStack based cloud."},{"line_number":39,"context_line":""},{"line_number":40,"context_line":"Since OpenStack has grown and contains many more projects, the"},{"line_number":41,"context_line":"documentation team will concentrate on the core projects in the"}],"source_content_type":"text/x-rst","patch_set":3,"id":"9a061dce_615d21e9","line":38,"range":{"start_line":36,"start_character":0,"end_line":38,"end_character":25},"in_reply_to":"9a061dce_9ccee058","updated":"2016-04-04 23:16:19.000000000","message":"This should be clarified. Required to run OpenStack usually means what is required for trademark usage to say you are \"OpenStack powered platform\" versus other configurations which label you as \"OpenStack powered compute\". http://www.openstack.org/brand/interop/\n\nLana has previously stated in reviews that the only projects accepted are defcore accepted, however, projects like glance are not defcore accepted.\n\nhttps://review.openstack.org/#/c/213756/\n\nIf you want to talk about the bare minimum, this has been defined in the stater kit tag:\n\nhttp://governance.openstack.org/reference/tags/starter-kit_compute.html","commit_id":"500852c21a81e8653cdc46c4b493ceb6b994308c"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"e7e01b5b4007c613697063a6693675ec5a383a2e","unresolved":false,"context_lines":[{"line_number":33,"context_line":"The documentation team will update and test the guide for each"},{"line_number":34,"context_line":"release."},{"line_number":35,"context_line":""},{"line_number":36,"context_line":"No further projects will be added to the guide unless they are"},{"line_number":37,"context_line":"required by one of the existing projects or generally required to run"},{"line_number":38,"context_line":"an OpenStack based cloud."},{"line_number":39,"context_line":""},{"line_number":40,"context_line":"Since OpenStack has grown and contains many more projects, the"},{"line_number":41,"context_line":"documentation team will concentrate on the core projects in the"}],"source_content_type":"text/x-rst","patch_set":3,"id":"9a061dce_1c0ad0d2","line":38,"range":{"start_line":36,"start_character":0,"end_line":38,"end_character":25},"in_reply_to":"9a061dce_ad0c5595","updated":"2016-04-04 19:52:14.000000000","message":"Not a \"Proof of Concept Guide\". If at all, then an \"Install a PoC\" Guide - but it\u0027s more. A guide that tells you the basic installation so that you learn about OpenStack.\n\nfor a serious installation - including a PoC - I strongly suggest to use some automated tools.","commit_id":"500852c21a81e8653cdc46c4b493ceb6b994308c"},{"author":{"_account_id":16157,"name":"Ken Johnston","email":"kenny@kencjohnston.com","username":"kencjohnston"},"change_message_id":"7947f6e6bba98c5d2c3a22deb9516e6adb8fb344","unresolved":false,"context_lines":[{"line_number":50,"context_line":"their own Install Guide."},{"line_number":51,"context_line":""},{"line_number":52,"context_line":"For example, Orchestration could store their install guide in the heat"},{"line_number":53,"context_line":"repository, and publish to "},{"line_number":54,"context_line":"http://docs.openstack.org/developer/heat/install-guide/ ."},{"line_number":55,"context_line":""},{"line_number":56,"context_line":"Then the chapter \"Additional projects\" would contain:"}],"source_content_type":"text/x-rst","patch_set":3,"id":"9a061dce_dc4698be","line":53,"range":{"start_line":53,"start_character":26,"end_line":53,"end_character":27},"updated":"2016-04-04 19:59:38.000000000","message":"nit: whitespace","commit_id":"500852c21a81e8653cdc46c4b493ceb6b994308c"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"957fd1c6b88d5b0d7733ad93a0a351ef880ce97f","unresolved":false,"context_lines":[{"line_number":50,"context_line":"their own Install Guide."},{"line_number":51,"context_line":""},{"line_number":52,"context_line":"For example, Orchestration could store their install guide in the heat"},{"line_number":53,"context_line":"repository, and publish to "},{"line_number":54,"context_line":"http://docs.openstack.org/developer/heat/install-guide/ ."},{"line_number":55,"context_line":""},{"line_number":56,"context_line":"Then the chapter \"Additional projects\" would contain:"}],"source_content_type":"text/x-rst","patch_set":3,"id":"9a061dce_11cf4980","line":53,"range":{"start_line":53,"start_character":26,"end_line":53,"end_character":27},"in_reply_to":"9a061dce_dc4698be","updated":"2016-04-05 06:55:47.000000000","message":"Done","commit_id":"500852c21a81e8653cdc46c4b493ceb6b994308c"},{"author":{"_account_id":16157,"name":"Ken Johnston","email":"kenny@kencjohnston.com","username":"kencjohnston"},"change_message_id":"ca50a56921b22ea97c06a510d610deceda108d30","unresolved":false,"context_lines":[{"line_number":51,"context_line":""},{"line_number":52,"context_line":"For example, Orchestration could store their install guide in the heat"},{"line_number":53,"context_line":"repository, and publish to "},{"line_number":54,"context_line":"http://docs.openstack.org/developer/heat/install-guide/ ."},{"line_number":55,"context_line":""},{"line_number":56,"context_line":"Then the chapter \"Additional projects\" would contain:"},{"line_number":57,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"9a061dce_cd51c964","line":54,"range":{"start_line":54,"start_character":0,"end_line":54,"end_character":55},"updated":"2016-04-04 19:24:27.000000000","message":"There was a suggestion on the mailing list[1] to instead use http://docs.openstack.org/install-guide/heat/\n[1]http://lists.openstack.org/pipermail/openstack-dev/2016-March/090465.html","commit_id":"500852c21a81e8653cdc46c4b493ceb6b994308c"},{"author":{"_account_id":16157,"name":"Ken Johnston","email":"kenny@kencjohnston.com","username":"kencjohnston"},"change_message_id":"5e2d0e6782169bbad4a8a56f3886627c5cd6bbcb","unresolved":false,"context_lines":[{"line_number":51,"context_line":""},{"line_number":52,"context_line":"For example, Orchestration could store their install guide in the heat"},{"line_number":53,"context_line":"repository, and publish to "},{"line_number":54,"context_line":"http://docs.openstack.org/developer/heat/install-guide/ ."},{"line_number":55,"context_line":""},{"line_number":56,"context_line":"Then the chapter \"Additional projects\" would contain:"},{"line_number":57,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"9a061dce_9cf54085","line":54,"range":{"start_line":54,"start_character":0,"end_line":54,"end_character":55},"in_reply_to":"9a061dce_7ccaeca2","updated":"2016-04-04 19:59:08.000000000","message":"+1 I was mostly hoping to maintain the doc.o.o/install-guide as a place to learn about performing an OpenStack Install, with links to the current \"Install Guide\" if you are interested in learning how the process works and getting started quickly.","commit_id":"500852c21a81e8653cdc46c4b493ceb6b994308c"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"957fd1c6b88d5b0d7733ad93a0a351ef880ce97f","unresolved":false,"context_lines":[{"line_number":51,"context_line":""},{"line_number":52,"context_line":"For example, Orchestration could store their install guide in the heat"},{"line_number":53,"context_line":"repository, and publish to "},{"line_number":54,"context_line":"http://docs.openstack.org/developer/heat/install-guide/ ."},{"line_number":55,"context_line":""},{"line_number":56,"context_line":"Then the chapter \"Additional projects\" would contain:"},{"line_number":57,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"9a061dce_b1877d0e","line":54,"range":{"start_line":54,"start_character":0,"end_line":54,"end_character":55},"in_reply_to":"9a061dce_9cf54085","updated":"2016-04-05 06:55:47.000000000","message":"Changed link proposal so that we have distinct directories for each guide.","commit_id":"500852c21a81e8653cdc46c4b493ceb6b994308c"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"e7e01b5b4007c613697063a6693675ec5a383a2e","unresolved":false,"context_lines":[{"line_number":51,"context_line":""},{"line_number":52,"context_line":"For example, Orchestration could store their install guide in the heat"},{"line_number":53,"context_line":"repository, and publish to "},{"line_number":54,"context_line":"http://docs.openstack.org/developer/heat/install-guide/ ."},{"line_number":55,"context_line":""},{"line_number":56,"context_line":"Then the chapter \"Additional projects\" would contain:"},{"line_number":57,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"9a061dce_7ccaeca2","line":54,"range":{"start_line":54,"start_character":0,"end_line":54,"end_character":55},"in_reply_to":"9a061dce_cd51c964","updated":"2016-04-04 19:52:14.000000000","message":"The important thing for me is what we call the bike shed ;)\n\nPutting it inside the proposed path allows to publish with the same job as the others. But then we might not be able to use the openstackdocstheme, so let\u0027s revisit later.","commit_id":"500852c21a81e8653cdc46c4b493ceb6b994308c"},{"author":{"_account_id":10497,"name":"KATO Tomoyuki","email":"kato.tomoyuki@jp.fujitsu.com","username":"to222"},"change_message_id":"d369420b64a5d6bc94bfd1ecbbcf7bb67e077c2f","unresolved":false,"context_lines":[{"line_number":73,"context_line":"  setup but can just point out differences for their project."},{"line_number":74,"context_line":""},{"line_number":75,"context_line":"* We encourage projects to follow the documentation conventions as"},{"line_number":76,"context_line":"  written down in the Contributor\u0027s Guide."},{"line_number":77,"context_line":""},{"line_number":78,"context_line":"* We encourage projects to use the same theme (called"},{"line_number":79,"context_line":"  openstackdocstheme) as the Install Guide."}],"source_content_type":"text/x-rst","patch_set":3,"id":"9a061dce_454c68c7","line":76,"range":{"start_line":76,"start_character":22,"end_line":76,"end_character":41},"updated":"2016-04-04 23:52:22.000000000","message":"\"Documentation Contributor Guide\". you mean?","commit_id":"500852c21a81e8653cdc46c4b493ceb6b994308c"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"957fd1c6b88d5b0d7733ad93a0a351ef880ce97f","unresolved":false,"context_lines":[{"line_number":73,"context_line":"  setup but can just point out differences for their project."},{"line_number":74,"context_line":""},{"line_number":75,"context_line":"* We encourage projects to follow the documentation conventions as"},{"line_number":76,"context_line":"  written down in the Contributor\u0027s Guide."},{"line_number":77,"context_line":""},{"line_number":78,"context_line":"* We encourage projects to use the same theme (called"},{"line_number":79,"context_line":"  openstackdocstheme) as the Install Guide."}],"source_content_type":"text/x-rst","patch_set":3,"id":"9a061dce_f179f530","line":76,"range":{"start_line":76,"start_character":22,"end_line":76,"end_character":41},"in_reply_to":"9a061dce_454c68c7","updated":"2016-04-05 06:55:47.000000000","message":"Done","commit_id":"500852c21a81e8653cdc46c4b493ceb6b994308c"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"14b0796fc87e192173e82ee5db785c17ccb6c71d","unresolved":false,"context_lines":[{"line_number":79,"context_line":"  openstackdocstheme) as the Install Guide."},{"line_number":80,"context_line":""},{"line_number":81,"context_line":"* We encourage projects to support the same distributions as the"},{"line_number":82,"context_line":"  Install Guide does."},{"line_number":83,"context_line":""},{"line_number":84,"context_line":""},{"line_number":85,"context_line":"Alternatives"}],"source_content_type":"text/x-rst","patch_set":3,"id":"9a061dce_68950be3","line":82,"updated":"2016-04-04 19:40:54.000000000","message":"I\u0027m afraid these \"external\" guides will lack the proactive approach (updates/testing/validation) that made the \"primary\" installation guide much better over the last few years. Frustration with initial operations such as installation negatively impacts adoption of a project and possibly OpenStack. The documentation team doesn\u0027t have time to validate instructions for all projects nor can it monitor bug reports outside of openstack-manuals. We could try letting projects \"self-validate\" each release and adopt some sort of governance if it falls into chaos... or just adopt governance initially. I don\u0027t know who would enforce such a thing.","commit_id":"500852c21a81e8653cdc46c4b493ceb6b994308c"},{"author":{"_account_id":170,"name":"Mike Perez","email":"thingee@gmail.com","username":"thingee"},"change_message_id":"46695acb5e36f57e38ccea2b8a4b6ebe676e2a14","unresolved":false,"context_lines":[{"line_number":79,"context_line":"  openstackdocstheme) as the Install Guide."},{"line_number":80,"context_line":""},{"line_number":81,"context_line":"* We encourage projects to support the same distributions as the"},{"line_number":82,"context_line":"  Install Guide does."},{"line_number":83,"context_line":""},{"line_number":84,"context_line":""},{"line_number":85,"context_line":"Alternatives"}],"source_content_type":"text/x-rst","patch_set":3,"id":"9a061dce_c1022d3e","line":82,"in_reply_to":"9a061dce_1c793094","updated":"2016-04-04 23:16:19.000000000","message":"As others have stated on the mailing list and Andreas is addressing here, it\u0027s clear the docs team cannot take on all big tent projects, however, we have projects that need to move forward.\n\nOperators at the last midcycle in Manchester have already stated that they\u0027re frustrated that there are not install docs for projects that they want to try out that the install docs team chooses not to cover.\n\nI would argue without these install docs, projects can\u0027t begin to get better adoption and mature since people are scratching their head on how to begin doing a test deployment.","commit_id":"500852c21a81e8653cdc46c4b493ceb6b994308c"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"e7e01b5b4007c613697063a6693675ec5a383a2e","unresolved":false,"context_lines":[{"line_number":79,"context_line":"  openstackdocstheme) as the Install Guide."},{"line_number":80,"context_line":""},{"line_number":81,"context_line":"* We encourage projects to support the same distributions as the"},{"line_number":82,"context_line":"  Install Guide does."},{"line_number":83,"context_line":""},{"line_number":84,"context_line":""},{"line_number":85,"context_line":"Alternatives"}],"source_content_type":"text/x-rst","patch_set":3,"id":"9a061dce_1c793094","line":82,"in_reply_to":"9a061dce_68950be3","updated":"2016-04-04 19:52:14.000000000","message":"Yes, quality is a issue. Do you have some good ideas that allow this to scale and still have quality?\n\nright now I see the docs team basically in the role of creating guidelines and thus enabling others. \n\nBtw. The docs team should not get these bugs at all, the openstackdocstheme creates bugs directly in the project bug queues.","commit_id":"500852c21a81e8653cdc46c4b493ceb6b994308c"},{"author":{"_account_id":170,"name":"Mike Perez","email":"thingee@gmail.com","username":"thingee"},"change_message_id":"e6ac13739216bfbe3d2fc84c81e428f842a093b5","unresolved":false,"context_lines":[{"line_number":146,"context_line":"----------"},{"line_number":147,"context_line":""},{"line_number":148,"context_line":"Project teams can publish their content to"},{"line_number":149,"context_line":"``docs.openstack.org/project-install-guide/VERSION/SERVICE/ ``. ``VERSION`` is"},{"line_number":150,"context_line":"the release like ``mitaka`` or ``newton``, ``SERVICE`` is the service"},{"line_number":151,"context_line":"name like ``orchestration``. For publishing from master, the"},{"line_number":152,"context_line":"``VERSION`` should be ``draft``."}],"source_content_type":"text/x-rst","patch_set":4,"id":"9a061dce_df2654b9","line":149,"updated":"2016-04-05 16:58:50.000000000","message":"Maybe just say RELEASE instead of VERSION to avoid confusion with our usage of semantic versions that is different across different projects for every release.","commit_id":"a3160a6b875209c3d4ad3ddb28f00a5cfde4c9ca"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"2a201eeccdb22ce72f9eadeada16e1ab5ae39303","unresolved":false,"context_lines":[{"line_number":146,"context_line":"----------"},{"line_number":147,"context_line":""},{"line_number":148,"context_line":"Project teams can publish their content to"},{"line_number":149,"context_line":"``docs.openstack.org/project-install-guide/VERSION/SERVICE/ ``. ``VERSION`` is"},{"line_number":150,"context_line":"the release like ``mitaka`` or ``newton``, ``SERVICE`` is the service"},{"line_number":151,"context_line":"name like ``orchestration``. For publishing from master, the"},{"line_number":152,"context_line":"``VERSION`` should be ``draft``."}],"source_content_type":"text/x-rst","patch_set":4,"id":"9a061dce_5f8a44c0","line":149,"in_reply_to":"9a061dce_df2654b9","updated":"2016-04-05 17:09:55.000000000","message":"Done","commit_id":"a3160a6b875209c3d4ad3ddb28f00a5cfde4c9ca"},{"author":{"_account_id":170,"name":"Mike Perez","email":"thingee@gmail.com","username":"thingee"},"change_message_id":"e6ac13739216bfbe3d2fc84c81e428f842a093b5","unresolved":false,"context_lines":[{"line_number":179,"context_line":"Work Items"},{"line_number":180,"context_line":"----------"},{"line_number":181,"context_line":""},{"line_number":182,"context_line":"* Move not anymore documented projects out of the guide in their own"},{"line_number":183,"context_line":"  repositories: Orchestration (heat), Telemetry (telemetry), Object"},{"line_number":184,"context_line":"  Storage (swift), Shared File system (manila)."},{"line_number":185,"context_line":""}],"source_content_type":"text/x-rst","patch_set":4,"id":"9a061dce_5ffa44be","line":182,"updated":"2016-04-05 16:58:50.000000000","message":"The original reason why projects like Manila were doing this is to fulfill the install guide requirement. In order for these guides to gain adoption, we should probably start discussion with the ops tag team on potentially amending the requirement here http://git.openstack.org/cgit/openstack/ops-tags-team/tree/descriptions/ops-docs-install-guide.rst\n\nI\u0027m happy to do this once this spec moves forward.","commit_id":"a3160a6b875209c3d4ad3ddb28f00a5cfde4c9ca"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"2a201eeccdb22ce72f9eadeada16e1ab5ae39303","unresolved":false,"context_lines":[{"line_number":179,"context_line":"Work Items"},{"line_number":180,"context_line":"----------"},{"line_number":181,"context_line":""},{"line_number":182,"context_line":"* Move not anymore documented projects out of the guide in their own"},{"line_number":183,"context_line":"  repositories: Orchestration (heat), Telemetry (telemetry), Object"},{"line_number":184,"context_line":"  Storage (swift), Shared File system (manila)."},{"line_number":185,"context_line":""}],"source_content_type":"text/x-rst","patch_set":4,"id":"9a061dce_7f2bc894","line":182,"in_reply_to":"9a061dce_5ffa44be","updated":"2016-04-05 17:09:55.000000000","message":"Added link and volunteered you ;)\n\nthanks","commit_id":"a3160a6b875209c3d4ad3ddb28f00a5cfde4c9ca"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"77c61e1b8d24d2165fa07efc6497367e30655b53","unresolved":false,"context_lines":[{"line_number":13,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":14,"context_line":""},{"line_number":15,"context_line":"With the growing OpenStack Big Tent, many projects need to create"},{"line_number":16,"context_line":"Install Guides. The current Install Guide is concentrating on a small"},{"line_number":17,"context_line":"set of projects and gets tested each release. Documenting and testing"},{"line_number":18,"context_line":"all projects in the Install Guide is not possible with the current"},{"line_number":19,"context_line":"size of the OpenStack Documentation team."}],"source_content_type":"text/x-rst","patch_set":5,"id":"9a061dce_f04c1844","line":16,"updated":"2016-04-06 00:55:15.000000000","message":"We should use \"installation guide\" instead of \"install guide\" in a consistent fashion.\n\nNit: \"Install Guide\" and \"Installation Guide\" are not proper nouns and therefore should use lower-case.","commit_id":"a621cd7beabee30b245b8a83d719909f512fcf27"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"7e058a07ab2b867483e3ce825dfb001017c83367","unresolved":false,"context_lines":[{"line_number":13,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":14,"context_line":""},{"line_number":15,"context_line":"With the growing OpenStack Big Tent, many projects need to create"},{"line_number":16,"context_line":"Install Guides. The current Install Guide is concentrating on a small"},{"line_number":17,"context_line":"set of projects and gets tested each release. Documenting and testing"},{"line_number":18,"context_line":"all projects in the Install Guide is not possible with the current"},{"line_number":19,"context_line":"size of the OpenStack Documentation team."}],"source_content_type":"text/x-rst","patch_set":5,"id":"9a061dce_56de9711","line":16,"in_reply_to":"9a061dce_f04c1844","updated":"2016-04-06 06:50:03.000000000","message":"Just check http://docs.openstack.org/ ;(\n\nI\u0027ll use install guides here now.","commit_id":"a621cd7beabee30b245b8a83d719909f512fcf27"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"77c61e1b8d24d2165fa07efc6497367e30655b53","unresolved":false,"context_lines":[{"line_number":16,"context_line":"Install Guides. The current Install Guide is concentrating on a small"},{"line_number":17,"context_line":"set of projects and gets tested each release. Documenting and testing"},{"line_number":18,"context_line":"all projects in the Install Guide is not possible with the current"},{"line_number":19,"context_line":"size of the OpenStack Documentation team."},{"line_number":20,"context_line":""},{"line_number":21,"context_line":"We therefore need to find a way that allows projects to write their"},{"line_number":22,"context_line":"own Install Guides without involvement of  the Documentation team -"}],"source_content_type":"text/x-rst","patch_set":5,"id":"9a061dce_703808a1","line":19,"updated":"2016-04-06 00:55:15.000000000","message":"Nor is it the responsibility of the documentation team to thoroughly understand configuration and deployment of each project.\n\nNit:\"Documentation\" referencing the team is not a proper noun and therefore should use lower-case.","commit_id":"a621cd7beabee30b245b8a83d719909f512fcf27"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"7e058a07ab2b867483e3ce825dfb001017c83367","unresolved":false,"context_lines":[{"line_number":16,"context_line":"Install Guides. The current Install Guide is concentrating on a small"},{"line_number":17,"context_line":"set of projects and gets tested each release. Documenting and testing"},{"line_number":18,"context_line":"all projects in the Install Guide is not possible with the current"},{"line_number":19,"context_line":"size of the OpenStack Documentation team."},{"line_number":20,"context_line":""},{"line_number":21,"context_line":"We therefore need to find a way that allows projects to write their"},{"line_number":22,"context_line":"own Install Guides without involvement of  the Documentation team -"}],"source_content_type":"text/x-rst","patch_set":5,"id":"9a061dce_7610fba8","line":19,"in_reply_to":"9a061dce_703808a1","updated":"2016-04-06 06:50:03.000000000","message":"Done","commit_id":"a621cd7beabee30b245b8a83d719909f512fcf27"},{"author":{"_account_id":10497,"name":"KATO Tomoyuki","email":"kato.tomoyuki@jp.fujitsu.com","username":"to222"},"change_message_id":"8f75091cdf749fb28393cafda04fd36013afb124","unresolved":false,"context_lines":[{"line_number":19,"context_line":"size of the OpenStack Documentation team."},{"line_number":20,"context_line":""},{"line_number":21,"context_line":"We therefore need to find a way that allows projects to write their"},{"line_number":22,"context_line":"own Install Guides without involvement of  the Documentation team -"},{"line_number":23,"context_line":"and the Documentation team acting as enabler for these documents."},{"line_number":24,"context_line":""},{"line_number":25,"context_line":"Proposed change"}],"source_content_type":"text/x-rst","patch_set":5,"id":"9a061dce_56edfc23","line":22,"range":{"start_line":22,"start_character":41,"end_line":22,"end_character":43},"updated":"2016-04-06 02:51:16.000000000","message":"nit: one space","commit_id":"a621cd7beabee30b245b8a83d719909f512fcf27"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"77c61e1b8d24d2165fa07efc6497367e30655b53","unresolved":false,"context_lines":[{"line_number":64,"context_line":"* Block storage service (cinder): Part of current Install Guide and"},{"line_number":65,"context_line":"  required by many use cases."},{"line_number":66,"context_line":"* Dashboard (horizon): Part of current Install Guide and required by"},{"line_number":67,"context_line":"  many users."},{"line_number":68,"context_line":""},{"line_number":69,"context_line":"No further projects will be added to the guide unless they are"},{"line_number":70,"context_line":"required by one of the existing projects or generally required to run"}],"source_content_type":"text/x-rst","patch_set":5,"id":"9a061dce_1000aca9","line":67,"updated":"2016-04-06 00:55:15.000000000","message":"For projects not in this list, but currently in the installation guide, do we let them move existing code into their respective repositories rather than simply removing it?","commit_id":"a621cd7beabee30b245b8a83d719909f512fcf27"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"7e058a07ab2b867483e3ce825dfb001017c83367","unresolved":false,"context_lines":[{"line_number":64,"context_line":"* Block storage service (cinder): Part of current Install Guide and"},{"line_number":65,"context_line":"  required by many use cases."},{"line_number":66,"context_line":"* Dashboard (horizon): Part of current Install Guide and required by"},{"line_number":67,"context_line":"  many users."},{"line_number":68,"context_line":""},{"line_number":69,"context_line":"No further projects will be added to the guide unless they are"},{"line_number":70,"context_line":"required by one of the existing projects or generally required to run"}],"source_content_type":"text/x-rst","patch_set":5,"id":"9a061dce_d66e272e","line":67,"in_reply_to":"9a061dce_1000aca9","updated":"2016-04-06 06:50:03.000000000","message":"I think we should help them move it so that we have consistent guides as starting point.","commit_id":"a621cd7beabee30b245b8a83d719909f512fcf27"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"77c61e1b8d24d2165fa07efc6497367e30655b53","unresolved":false,"context_lines":[{"line_number":71,"context_line":"an OpenStack based cloud."},{"line_number":72,"context_line":""},{"line_number":73,"context_line":"The Documentation team will update and test the Install Guide for each"},{"line_number":74,"context_line":"release."},{"line_number":75,"context_line":""},{"line_number":76,"context_line":"The Install Guide will be enhanced to link to additional project"},{"line_number":77,"context_line":"specific install guides. For this, it will have in a separate chapter"}],"source_content_type":"text/x-rst","patch_set":5,"id":"9a061dce_b0274063","line":74,"updated":"2016-04-06 00:55:15.000000000","message":"The documentation team updates and tests the primary/central/core installation guide for each release.","commit_id":"a621cd7beabee30b245b8a83d719909f512fcf27"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"7e058a07ab2b867483e3ce825dfb001017c83367","unresolved":false,"context_lines":[{"line_number":71,"context_line":"an OpenStack based cloud."},{"line_number":72,"context_line":""},{"line_number":73,"context_line":"The Documentation team will update and test the Install Guide for each"},{"line_number":74,"context_line":"release."},{"line_number":75,"context_line":""},{"line_number":76,"context_line":"The Install Guide will be enhanced to link to additional project"},{"line_number":77,"context_line":"specific install guides. For this, it will have in a separate chapter"}],"source_content_type":"text/x-rst","patch_set":5,"id":"9a061dce_b669f327","line":74,"in_reply_to":"9a061dce_b0274063","updated":"2016-04-06 06:50:03.000000000","message":"Done","commit_id":"a621cd7beabee30b245b8a83d719909f512fcf27"},{"author":{"_account_id":10497,"name":"KATO Tomoyuki","email":"kato.tomoyuki@jp.fujitsu.com","username":"to222"},"change_message_id":"8f75091cdf749fb28393cafda04fd36013afb124","unresolved":false,"context_lines":[{"line_number":118,"context_line":"  point out differences for the specific project."},{"line_number":119,"context_line":""},{"line_number":120,"context_line":"* We encourage projects to follow the documentation conventions as"},{"line_number":121,"context_line":"  written down in the `Documentation Contributor\u0027s Guide"},{"line_number":122,"context_line":"  \u003chttp://docs.openstack.org/contributor-guide/\u003e`__."},{"line_number":123,"context_line":""},{"line_number":124,"context_line":"* We encourage projects to use the same theme (called"}],"source_content_type":"text/x-rst","patch_set":5,"id":"9a061dce_36c0487b","line":121,"range":{"start_line":121,"start_character":37,"end_line":121,"end_character":50},"updated":"2016-04-06 02:51:16.000000000","message":"Contributor","commit_id":"a621cd7beabee30b245b8a83d719909f512fcf27"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"7e058a07ab2b867483e3ce825dfb001017c83367","unresolved":false,"context_lines":[{"line_number":118,"context_line":"  point out differences for the specific project."},{"line_number":119,"context_line":""},{"line_number":120,"context_line":"* We encourage projects to follow the documentation conventions as"},{"line_number":121,"context_line":"  written down in the `Documentation Contributor\u0027s Guide"},{"line_number":122,"context_line":"  \u003chttp://docs.openstack.org/contributor-guide/\u003e`__."},{"line_number":123,"context_line":""},{"line_number":124,"context_line":"* We encourage projects to use the same theme (called"}],"source_content_type":"text/x-rst","patch_set":5,"id":"9a061dce_96d2efd0","line":121,"range":{"start_line":121,"start_character":37,"end_line":121,"end_character":50},"in_reply_to":"9a061dce_36c0487b","updated":"2016-04-06 06:50:03.000000000","message":"Done","commit_id":"a621cd7beabee30b245b8a83d719909f512fcf27"},{"author":{"_account_id":10497,"name":"KATO Tomoyuki","email":"kato.tomoyuki@jp.fujitsu.com","username":"to222"},"change_message_id":"8f75091cdf749fb28393cafda04fd36013afb124","unresolved":false,"context_lines":[{"line_number":129,"context_line":"  OpenStack packages from distributors or installation from source."},{"line_number":130,"context_line":""},{"line_number":131,"context_line":"* Project specific guides should be versioned, so create a specific"},{"line_number":132,"context_line":"  version for each release that gets published from their release"},{"line_number":133,"context_line":"  branch."},{"line_number":134,"context_line":""},{"line_number":135,"context_line":"* RST is the preferred documentation format and our tools for"}],"source_content_type":"text/x-rst","patch_set":5,"id":"9a061dce_f673707e","line":132,"updated":"2016-04-06 02:51:16.000000000","message":"Question: does \"published from their release branch\" mean that each project need to follow the stable branch release policy? I think it is enough each project use the subdirectories for \"versioned\".","commit_id":"a621cd7beabee30b245b8a83d719909f512fcf27"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"7e058a07ab2b867483e3ce825dfb001017c83367","unresolved":false,"context_lines":[{"line_number":129,"context_line":"  OpenStack packages from distributors or installation from source."},{"line_number":130,"context_line":""},{"line_number":131,"context_line":"* Project specific guides should be versioned, so create a specific"},{"line_number":132,"context_line":"  version for each release that gets published from their release"},{"line_number":133,"context_line":"  branch."},{"line_number":134,"context_line":""},{"line_number":135,"context_line":"* RST is the preferred documentation format and our tools for"}],"source_content_type":"text/x-rst","patch_set":5,"id":"9a061dce_16fedf36","line":132,"in_reply_to":"9a061dce_f673707e","updated":"2016-04-06 06:50:03.000000000","message":"let me try rewording...","commit_id":"a621cd7beabee30b245b8a83d719909f512fcf27"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"77c61e1b8d24d2165fa07efc6497367e30655b53","unresolved":false,"context_lines":[{"line_number":166,"context_line":"  proposed in this spec to it."},{"line_number":167,"context_line":"* Status quo: One central Installation Guide that is maintained by the"},{"line_number":168,"context_line":"  documentation team and no project specific guides for those projects"},{"line_number":169,"context_line":"  that are not part of the central guide."},{"line_number":170,"context_line":""},{"line_number":171,"context_line":""},{"line_number":172,"context_line":"Implementation"}],"source_content_type":"text/x-rst","patch_set":5,"id":"9a061dce_10eeeceb","line":169,"updated":"2016-04-06 00:55:15.000000000","message":"The existing approach cannot continue unless we receive a commitment of resources from each project in the installation guide.","commit_id":"a621cd7beabee30b245b8a83d719909f512fcf27"},{"author":{"_account_id":20498,"name":"Spyros Trigazis","email":"spyridon.trigazis@cern.ch","username":"strigazi"},"change_message_id":"c54962d2b6965c97fdf1bd07aafd89543e42ba5e","unresolved":false,"context_lines":[{"line_number":166,"context_line":"  proposed in this spec to it."},{"line_number":167,"context_line":"* Status quo: One central Installation Guide that is maintained by the"},{"line_number":168,"context_line":"  documentation team and no project specific guides for those projects"},{"line_number":169,"context_line":"  that are not part of the central guide."},{"line_number":170,"context_line":""},{"line_number":171,"context_line":""},{"line_number":172,"context_line":"Implementation"}],"source_content_type":"text/x-rst","patch_set":5,"id":"9a061dce_241f5bb8","line":169,"in_reply_to":"9a061dce_10eeeceb","updated":"2016-04-06 13:18:23.000000000","message":"+1\nAdditionally, if we have a single install guide and this guide grows too much, I think it will be more confusing than helpful since it will contain information not needed by all projects.","commit_id":"a621cd7beabee30b245b8a83d719909f512fcf27"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"77c61e1b8d24d2165fa07efc6497367e30655b53","unresolved":false,"context_lines":[{"line_number":179,"context_line":"Work Items"},{"line_number":180,"context_line":"----------"},{"line_number":181,"context_line":""},{"line_number":182,"context_line":"* Move not anymore documented projects out of the guide in their own"},{"line_number":183,"context_line":"  repositories: Orchestration (heat), Telemetry (telemetry), Object"},{"line_number":184,"context_line":"  Storage (swift), Shared File system (manila)."},{"line_number":185,"context_line":""}],"source_content_type":"text/x-rst","patch_set":5,"id":"9a061dce_b0b580ef","line":182,"updated":"2016-04-06 00:55:15.000000000","message":"Nit: Change \"not anymore\" to \"non-core\" or similar wording.","commit_id":"a621cd7beabee30b245b8a83d719909f512fcf27"},{"author":{"_account_id":6537,"name":"gordon chung","email":"gord@live.ca","username":"chungg"},"change_message_id":"8aa26897277674c6f9338251f211ad70136de946","unresolved":false,"context_lines":[{"line_number":37,"context_line":""},{"line_number":38,"context_line":"Ownership of the project specific install guides is with the"},{"line_number":39,"context_line":"respective project team, not the documentation team. This means the"},{"line_number":40,"context_line":"content is in a project specific repository, reviews will be done by"},{"line_number":41,"context_line":"the project team, and bug reports will go in the bug queue of the"},{"line_number":42,"context_line":"project."},{"line_number":43,"context_line":""}],"source_content_type":"text/x-rst","patch_set":6,"id":"9a061dce_4896d93f","line":40,"updated":"2016-04-06 14:47:52.000000000","message":"why do we need a new repo? can we not just store docs in projects repo? i think a big issue right now is that docs are separate from code so even with DocImpact flag, there\u0027s very little accountability to actually edit docs when code is changed.","commit_id":"9db8223188b2aea46538f9bbdbf77886f9b7fdaf"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"3ee0983e2a51a93a4774a579b09f5e1bb018fd4c","unresolved":false,"context_lines":[{"line_number":37,"context_line":""},{"line_number":38,"context_line":"Ownership of the project specific install guides is with the"},{"line_number":39,"context_line":"respective project team, not the documentation team. This means the"},{"line_number":40,"context_line":"content is in a project specific repository, reviews will be done by"},{"line_number":41,"context_line":"the project team, and bug reports will go in the bug queue of the"},{"line_number":42,"context_line":"project."},{"line_number":43,"context_line":""}],"source_content_type":"text/x-rst","patch_set":6,"id":"9a061dce_687bddf5","line":40,"in_reply_to":"9a061dce_4896d93f","updated":"2016-04-06 14:53:52.000000000","message":"No need for a new repo - but you can. TElemetry might want to put documentation for Aodh and ceilometer in ceilometer repo - or in a new repo.\n\nYour call.\n\nAny suggestion to make this clearer?","commit_id":"9db8223188b2aea46538f9bbdbf77886f9b7fdaf"},{"author":{"_account_id":20498,"name":"Spyros Trigazis","email":"spyridon.trigazis@cern.ch","username":"strigazi"},"change_message_id":"8fae0204be2e5937216116a6ec33c4fe6e8bc0d0","unresolved":false,"context_lines":[{"line_number":37,"context_line":""},{"line_number":38,"context_line":"Ownership of the project specific install guides is with the"},{"line_number":39,"context_line":"respective project team, not the documentation team. This means the"},{"line_number":40,"context_line":"content is in a project specific repository, reviews will be done by"},{"line_number":41,"context_line":"the project team, and bug reports will go in the bug queue of the"},{"line_number":42,"context_line":"project."},{"line_number":43,"context_line":""}],"source_content_type":"text/x-rst","patch_set":6,"id":"9a061dce_ae6b3df0","line":40,"in_reply_to":"9a061dce_687bddf5","updated":"2016-04-06 15:14:29.000000000","message":"This means the content is in an existing or a new repository owned by the project team, reviews will ...\n\nSomething like that","commit_id":"9db8223188b2aea46538f9bbdbf77886f9b7fdaf"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"ed2c55e9aa822e1e12e7379b98fa1640459f08cf","unresolved":false,"context_lines":[{"line_number":37,"context_line":""},{"line_number":38,"context_line":"Ownership of the project specific install guides is with the"},{"line_number":39,"context_line":"respective project team, not the documentation team. This means the"},{"line_number":40,"context_line":"content is in a project specific repository, reviews will be done by"},{"line_number":41,"context_line":"the project team, and bug reports will go in the bug queue of the"},{"line_number":42,"context_line":"project."},{"line_number":43,"context_line":""}],"source_content_type":"text/x-rst","patch_set":6,"id":"9a061dce_b7485fcd","line":40,"in_reply_to":"9a061dce_ae6b3df0","updated":"2016-04-07 18:44:34.000000000","message":"Done","commit_id":"9db8223188b2aea46538f9bbdbf77886f9b7fdaf"},{"author":{"_account_id":6537,"name":"gordon chung","email":"gord@live.ca","username":"chungg"},"change_message_id":"099444b45660be4b5f52563a0369c47114c5fc36","unresolved":false,"context_lines":[{"line_number":37,"context_line":""},{"line_number":38,"context_line":"Ownership of the project specific install guides is with the"},{"line_number":39,"context_line":"respective project team, not the documentation team. This means the"},{"line_number":40,"context_line":"content is in a project specific repository, reviews will be done by"},{"line_number":41,"context_line":"the project team, and bug reports will go in the bug queue of the"},{"line_number":42,"context_line":"project."},{"line_number":43,"context_line":""}],"source_content_type":"text/x-rst","patch_set":6,"id":"9a061dce_b0999cc6","line":40,"in_reply_to":"9a061dce_ae6b3df0","updated":"2016-04-07 14:06:38.000000000","message":"ah i see, i read it as something new. thanks for clarifying :)\n\ni like the rephrase.","commit_id":"9db8223188b2aea46538f9bbdbf77886f9b7fdaf"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"3b043c920e5e7f0eabbf053de5144a9deec4a6ab","unresolved":false,"context_lines":[{"line_number":45,"context_line":"project specific guides with mentoring, setting up needed"},{"line_number":46,"context_line":"infrastructure, writing of guidelines, providing a working base"},{"line_number":47,"context_line":"install guide that the project specific guides can use as"},{"line_number":48,"context_line":"reference."},{"line_number":49,"context_line":""},{"line_number":50,"context_line":""},{"line_number":51,"context_line":"Scope of basic install guide"}],"source_content_type":"text/x-rst","patch_set":6,"id":"9a061dce_76affc7c","line":48,"updated":"2016-04-07 14:38:29.000000000","message":"Consistency of structure and content plays a large role in the existing installation guide. How does the documentation team enforce consistency and other important attributes in installation guide patches that reside in project repositories? In the more generic case, how does the documentation team track patches in other repositories?","commit_id":"9db8223188b2aea46538f9bbdbf77886f9b7fdaf"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"ed2c55e9aa822e1e12e7379b98fa1640459f08cf","unresolved":false,"context_lines":[{"line_number":45,"context_line":"project specific guides with mentoring, setting up needed"},{"line_number":46,"context_line":"infrastructure, writing of guidelines, providing a working base"},{"line_number":47,"context_line":"install guide that the project specific guides can use as"},{"line_number":48,"context_line":"reference."},{"line_number":49,"context_line":""},{"line_number":50,"context_line":""},{"line_number":51,"context_line":"Scope of basic install guide"}],"source_content_type":"text/x-rst","patch_set":6,"id":"9a061dce_7729a7e5","line":48,"in_reply_to":"9a061dce_34828dc8","updated":"2016-04-07 18:44:34.000000000","message":"I agree with Mike. We need to mentor and give guideline - and good examples. If there\u0027s a certain structure, let\u0027s document it properly. What about proposing a skeleton for a project specific guide?\n\nLet\u0027s see what\u0027s helpfull...","commit_id":"9db8223188b2aea46538f9bbdbf77886f9b7fdaf"},{"author":{"_account_id":170,"name":"Mike Perez","email":"thingee@gmail.com","username":"thingee"},"change_message_id":"3f4dac39f6f3389254ef28a2387711e03fbd0735","unresolved":false,"context_lines":[{"line_number":45,"context_line":"project specific guides with mentoring, setting up needed"},{"line_number":46,"context_line":"infrastructure, writing of guidelines, providing a working base"},{"line_number":47,"context_line":"install guide that the project specific guides can use as"},{"line_number":48,"context_line":"reference."},{"line_number":49,"context_line":""},{"line_number":50,"context_line":""},{"line_number":51,"context_line":"Scope of basic install guide"}],"source_content_type":"text/x-rst","patch_set":6,"id":"9a061dce_34828dc8","line":48,"in_reply_to":"9a061dce_76affc7c","updated":"2016-04-07 18:25:15.000000000","message":"Making any guidelines accessible to the projects to follow. We can have a note in each project repo which links to the docs team recommendations.\n\nI don\u0027t think it\u0027s possible for the docs team to be able to enforce in each project if the whole reason why we\u0027re doing this is to lift the burden of maintaining these docs off the docs team to begin.","commit_id":"9db8223188b2aea46538f9bbdbf77886f9b7fdaf"},{"author":{"_account_id":6537,"name":"gordon chung","email":"gord@live.ca","username":"chungg"},"change_message_id":"8aa26897277674c6f9338251f211ad70136de946","unresolved":false,"context_lines":[{"line_number":74,"context_line":"each release."},{"line_number":75,"context_line":""},{"line_number":76,"context_line":"The install guide will be enhanced to link to additional project"},{"line_number":77,"context_line":"specific install guides. For this, it will have in a separate chapter"},{"line_number":78,"context_line":"for each official project a small section where each official project"},{"line_number":79,"context_line":"can give a short summary of their project together with a link to"},{"line_number":80,"context_line":"their own install guide."}],"source_content_type":"text/x-rst","patch_set":6,"id":"9a061dce_280285b4","line":77,"updated":"2016-04-06 14:47:52.000000000","message":"what\u0027s the criteria for link to project specific install guide? anything in big tent?\n\nas it\u0027s just a link, how do we ensure project specific info is discoverable from main guide?","commit_id":"9db8223188b2aea46538f9bbdbf77886f9b7fdaf"},{"author":{"_account_id":6537,"name":"gordon chung","email":"gord@live.ca","username":"chungg"},"change_message_id":"099444b45660be4b5f52563a0369c47114c5fc36","unresolved":false,"context_lines":[{"line_number":74,"context_line":"each release."},{"line_number":75,"context_line":""},{"line_number":76,"context_line":"The install guide will be enhanced to link to additional project"},{"line_number":77,"context_line":"specific install guides. For this, it will have in a separate chapter"},{"line_number":78,"context_line":"for each official project a small section where each official project"},{"line_number":79,"context_line":"can give a short summary of their project together with a link to"},{"line_number":80,"context_line":"their own install guide."}],"source_content_type":"text/x-rst","patch_set":6,"id":"9a061dce_b0751c65","line":77,"in_reply_to":"9a061dce_135ed211","updated":"2016-04-07 14:06:38.000000000","message":"ack, should we introduce some form of searchable keyword/tags for each section maybe?","commit_id":"9db8223188b2aea46538f9bbdbf77886f9b7fdaf"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"5fb50dae21408b3117fc496a3cf3c57fc49be597","unresolved":false,"context_lines":[{"line_number":74,"context_line":"each release."},{"line_number":75,"context_line":""},{"line_number":76,"context_line":"The install guide will be enhanced to link to additional project"},{"line_number":77,"context_line":"specific install guides. For this, it will have in a separate chapter"},{"line_number":78,"context_line":"for each official project a small section where each official project"},{"line_number":79,"context_line":"can give a short summary of their project together with a link to"},{"line_number":80,"context_line":"their own install guide."}],"source_content_type":"text/x-rst","patch_set":6,"id":"9a061dce_135ed211","line":77,"in_reply_to":"9a061dce_280285b4","updated":"2016-04-06 14:55:16.000000000","message":"It\u0027s not just a link - it\u0027s a section that includes the link. This a chance to not have just \"telemetry\" but some explanation to explain the benefits of telemetry.","commit_id":"9db8223188b2aea46538f9bbdbf77886f9b7fdaf"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"3ee0983e2a51a93a4774a579b09f5e1bb018fd4c","unresolved":false,"context_lines":[{"line_number":74,"context_line":"each release."},{"line_number":75,"context_line":""},{"line_number":76,"context_line":"The install guide will be enhanced to link to additional project"},{"line_number":77,"context_line":"specific install guides. For this, it will have in a separate chapter"},{"line_number":78,"context_line":"for each official project a small section where each official project"},{"line_number":79,"context_line":"can give a short summary of their project together with a link to"},{"line_number":80,"context_line":"their own install guide."}],"source_content_type":"text/x-rst","patch_set":6,"id":"9a061dce_53068a1d","line":77,"in_reply_to":"9a061dce_280285b4","updated":"2016-04-06 14:53:52.000000000","message":"Yes, anything in big tent.\n\nThe chapter is a top-level chapter and sections are shown in the table of contents, see http://docs.openstack.org/mitaka/install-guide-obs/\n\nFor exact ways, we have to write it. But goal is to make it discoverable.","commit_id":"9db8223188b2aea46538f9bbdbf77886f9b7fdaf"},{"author":{"_account_id":20498,"name":"Spyros Trigazis","email":"spyridon.trigazis@cern.ch","username":"strigazi"},"change_message_id":"6ac46044895968f9bb0496423f167e5f2e8b9a84","unresolved":false,"context_lines":[{"line_number":80,"context_line":"their own install guide."},{"line_number":81,"context_line":""},{"line_number":82,"context_line":""},{"line_number":83,"context_line":"For example, Orchestration could store their install guide in the ``heat``"},{"line_number":84,"context_line":"repository, and publish to"},{"line_number":85,"context_line":"http://docs.openstack.org/project-install-guide/mitaka/orchestration/ ."},{"line_number":86,"context_line":""},{"line_number":87,"context_line":"Then the chapter \"Additional projects\" would contain a small section:"}],"source_content_type":"text/x-rst","patch_set":6,"id":"9a061dce_df8bc6c1","line":84,"range":{"start_line":83,"start_character":0,"end_line":84,"end_character":10},"updated":"2016-04-06 13:18:54.000000000","message":"The project\u0027s repo should include all tests from openstack-manuals? To have a quality guide and more importantly a guide similar of those of core projects, project specific guides should pass the same tests. If operators are familiar with the nova, glance etc install guides, with a guide similar in structure and content they\u0027ll likely manage to install other projects successfully. \nAbout the infrastructure:\nSince a project\u0027s install guide will live in the project\u0027s repo, the corresponding infra must include the tests mentioned above.","commit_id":"9db8223188b2aea46538f9bbdbf77886f9b7fdaf"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"3ee0983e2a51a93a4774a579b09f5e1bb018fd4c","unresolved":false,"context_lines":[{"line_number":80,"context_line":"their own install guide."},{"line_number":81,"context_line":""},{"line_number":82,"context_line":""},{"line_number":83,"context_line":"For example, Orchestration could store their install guide in the ``heat``"},{"line_number":84,"context_line":"repository, and publish to"},{"line_number":85,"context_line":"http://docs.openstack.org/project-install-guide/mitaka/orchestration/ ."},{"line_number":86,"context_line":""},{"line_number":87,"context_line":"Then the chapter \"Additional projects\" would contain a small section:"}],"source_content_type":"text/x-rst","patch_set":6,"id":"9a061dce_88d471bd","line":84,"range":{"start_line":83,"start_character":0,"end_line":84,"end_character":10},"in_reply_to":"9a061dce_df8bc6c1","updated":"2016-04-06 14:53:52.000000000","message":"Up to the project - but yes, we should make this possible and document it. Will clearify in next revision.","commit_id":"9db8223188b2aea46538f9bbdbf77886f9b7fdaf"},{"author":{"_account_id":11536,"name":"hongbin","email":"hongbin034@gmail.com","username":"hongbin"},"change_message_id":"0292b80b845b1c4f4b5327bfa2a6db98faabe41d","unresolved":false,"context_lines":[{"line_number":89,"context_line":".. code::"},{"line_number":90,"context_line":""},{"line_number":91,"context_line":"   Orchestration service (heat)"},{"line_number":92,"context_line":"   \u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":93,"context_line":""},{"line_number":94,"context_line":"   The Orchestration service enables you to X and Y. Installation is"},{"line_number":95,"context_line":"   documented at"}],"source_content_type":"text/x-rst","patch_set":6,"id":"9a061dce_68975dec","line":92,"updated":"2016-04-06 15:02:52.000000000","message":"I don\u0027t like that. This treats other projects as second class citizen. I don\u0027t think it is a good idea to bless some projects and discriminate other projects.","commit_id":"9db8223188b2aea46538f9bbdbf77886f9b7fdaf"},{"author":{"_account_id":170,"name":"Mike Perez","email":"thingee@gmail.com","username":"thingee"},"change_message_id":"73fd68435506f4e45e0f8096a7759ca58daa2a1a","unresolved":false,"context_lines":[{"line_number":89,"context_line":".. code::"},{"line_number":90,"context_line":""},{"line_number":91,"context_line":"   Orchestration service (heat)"},{"line_number":92,"context_line":"   \u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":93,"context_line":""},{"line_number":94,"context_line":"   The Orchestration service enables you to X and Y. Installation is"},{"line_number":95,"context_line":"   documented at"}],"source_content_type":"text/x-rst","patch_set":6,"id":"9a061dce_b8b7fef3","line":92,"in_reply_to":"9a061dce_68975dec","updated":"2016-04-06 15:44:56.000000000","message":"The projects that are not in the \"additional projects\" section are the ones with the starter kit tag, plus additional ones the docs team has taken on writing in the past. I agree it is a bit odd, but not sure it will come out like that in the end. Right now these additional projects have zero installation documentation applicable to operators, which is way worse.\n\nhttp://governance.openstack.org/reference/tags/starter-kit_compute.html","commit_id":"9db8223188b2aea46538f9bbdbf77886f9b7fdaf"},{"author":{"_account_id":11536,"name":"hongbin","email":"hongbin034@gmail.com","username":"hongbin"},"change_message_id":"1ebc77118e82757b3ebd50a875af4862d526def6","unresolved":false,"context_lines":[{"line_number":89,"context_line":".. code::"},{"line_number":90,"context_line":""},{"line_number":91,"context_line":"   Orchestration service (heat)"},{"line_number":92,"context_line":"   \u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":93,"context_line":""},{"line_number":94,"context_line":"   The Orchestration service enables you to X and Y. Installation is"},{"line_number":95,"context_line":"   documented at"}],"source_content_type":"text/x-rst","patch_set":6,"id":"9a061dce_1bf7f28b","line":92,"in_reply_to":"9a061dce_b8b7fef3","updated":"2016-04-06 22:20:24.000000000","message":"Magnum will have an installation docs: https://review.openstack.org/#/c/288580/ . I hope it will be part of the OpenStack manual (not just a link).","commit_id":"9db8223188b2aea46538f9bbdbf77886f9b7fdaf"},{"author":{"_account_id":20498,"name":"Spyros Trigazis","email":"spyridon.trigazis@cern.ch","username":"strigazi"},"change_message_id":"6ac46044895968f9bb0496423f167e5f2e8b9a84","unresolved":false,"context_lines":[{"line_number":141,"context_line":"  from the governance repository. So, for example \"Orchestration"},{"line_number":142,"context_line":"  Service install guide\"."},{"line_number":143,"context_line":""},{"line_number":144,"context_line":"Publishing"},{"line_number":145,"context_line":"----------"},{"line_number":146,"context_line":""},{"line_number":147,"context_line":"Project teams can publish their content to"}],"source_content_type":"text/x-rst","patch_set":6,"id":"9a061dce_04a69752","line":144,"range":{"start_line":144,"start_character":0,"end_line":144,"end_character":10},"updated":"2016-04-06 13:18:54.000000000","message":"How this going to work, exactly? In each release a project\u0027s team will push the generated guide or the source to openstack-manuals?","commit_id":"9db8223188b2aea46538f9bbdbf77886f9b7fdaf"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"3ee0983e2a51a93a4774a579b09f5e1bb018fd4c","unresolved":false,"context_lines":[{"line_number":141,"context_line":"  from the governance repository. So, for example \"Orchestration"},{"line_number":142,"context_line":"  Service install guide\"."},{"line_number":143,"context_line":""},{"line_number":144,"context_line":"Publishing"},{"line_number":145,"context_line":"----------"},{"line_number":146,"context_line":""},{"line_number":147,"context_line":"Project teams can publish their content to"}],"source_content_type":"text/x-rst","patch_set":6,"id":"9a061dce_c88829c8","line":144,"range":{"start_line":144,"start_character":0,"end_line":144,"end_character":10},"in_reply_to":"9a061dce_04a69752","updated":"2016-04-06 14:53:52.000000000","message":"You already publish documents based on version, like http://docs.openstack.org/developer/nova/mitaka/\n\nThe infra scripts will take care to publish from stable/mitaka to /mitaka etc.","commit_id":"9db8223188b2aea46538f9bbdbf77886f9b7fdaf"},{"author":{"_account_id":11536,"name":"hongbin","email":"hongbin034@gmail.com","username":"hongbin"},"change_message_id":"2661e0f1b46abf0985321c2664f65f4857899db5","unresolved":false,"context_lines":[{"line_number":62,"context_line":"* Identity service (keystone): Part of starter-kit:compute."},{"line_number":63,"context_line":"* Networking service (neutron): Part of starter-kit:compute."},{"line_number":64,"context_line":"* Block storage service (cinder): Part of current install guide and"},{"line_number":65,"context_line":"  required by many use cases."},{"line_number":66,"context_line":"* Dashboard (horizon): Part of current install guide and required by"},{"line_number":67,"context_line":"  many users."},{"line_number":68,"context_line":""}],"source_content_type":"text/x-rst","patch_set":7,"id":"9a061dce_aaf0f6c9","line":65,"updated":"2016-04-07 19:17:53.000000000","message":"Other services might be required by many use cases as well. Would it be better to give a concrete and measurable scenario for including or excluding a project?","commit_id":"486585cc11cbc4f98ebc48872e4f1026e498b2a7"},{"author":{"_account_id":11536,"name":"hongbin","email":"hongbin034@gmail.com","username":"hongbin"},"change_message_id":"2661e0f1b46abf0985321c2664f65f4857899db5","unresolved":false,"context_lines":[{"line_number":64,"context_line":"* Block storage service (cinder): Part of current install guide and"},{"line_number":65,"context_line":"  required by many use cases."},{"line_number":66,"context_line":"* Dashboard (horizon): Part of current install guide and required by"},{"line_number":67,"context_line":"  many users."},{"line_number":68,"context_line":""},{"line_number":69,"context_line":"No further projects will be added to the guide unless they are"},{"line_number":70,"context_line":"required by one of the existing projects or generally required to run"}],"source_content_type":"text/x-rst","patch_set":7,"id":"9a061dce_8a99b27b","line":67,"updated":"2016-04-07 19:17:53.000000000","message":"Other services might be required by many users as well. Would it be better to give a concrete and measurable scenario for including or excluding a project?","commit_id":"486585cc11cbc4f98ebc48872e4f1026e498b2a7"},{"author":{"_account_id":11536,"name":"hongbin","email":"hongbin034@gmail.com","username":"hongbin"},"change_message_id":"2661e0f1b46abf0985321c2664f65f4857899db5","unresolved":false,"context_lines":[{"line_number":74,"context_line":"each release."},{"line_number":75,"context_line":""},{"line_number":76,"context_line":"The install guide will be enhanced to link to additional project"},{"line_number":77,"context_line":"specific install guides. For this, it will have in a separate chapter"},{"line_number":78,"context_line":"for each official project a small section where each official project"},{"line_number":79,"context_line":"can give a short summary of their project together with a link to"},{"line_number":80,"context_line":"their own install guide."},{"line_number":81,"context_line":""},{"line_number":82,"context_line":""},{"line_number":83,"context_line":"For example, Orchestration could store their install guide in the ``heat``"}],"source_content_type":"text/x-rst","patch_set":7,"id":"9a061dce_aa80f68b","line":80,"range":{"start_line":77,"start_character":25,"end_line":80,"end_character":24},"updated":"2016-04-07 19:17:53.000000000","message":"Users might consider a project with small section as a red flag. If they do, it will hurt the adoption of these projects.","commit_id":"486585cc11cbc4f98ebc48872e4f1026e498b2a7"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"9f691b2e1a2c05e92153901f017c7a424588c3da","unresolved":false,"context_lines":[{"line_number":74,"context_line":"each release."},{"line_number":75,"context_line":""},{"line_number":76,"context_line":"The install guide will be enhanced to link to additional project"},{"line_number":77,"context_line":"specific install guides. For this, it will have in a separate chapter"},{"line_number":78,"context_line":"for each official project a small section where each official project"},{"line_number":79,"context_line":"can give a short summary of their project together with a link to"},{"line_number":80,"context_line":"their own install guide."},{"line_number":81,"context_line":""},{"line_number":82,"context_line":""},{"line_number":83,"context_line":"For example, Orchestration could store their install guide in the ``heat``"}],"source_content_type":"text/x-rst","patch_set":7,"id":"9a061dce_cd4f4490","line":80,"range":{"start_line":77,"start_character":25,"end_line":80,"end_character":24},"in_reply_to":"9a061dce_aa80f68b","updated":"2016-04-07 19:30:35.000000000","message":"All such projects will have a small section - and there will be an introduction. let me clarify this a bit.","commit_id":"486585cc11cbc4f98ebc48872e4f1026e498b2a7"},{"author":{"_account_id":11536,"name":"hongbin","email":"hongbin034@gmail.com","username":"hongbin"},"change_message_id":"2661e0f1b46abf0985321c2664f65f4857899db5","unresolved":false,"context_lines":[{"line_number":93,"context_line":""},{"line_number":94,"context_line":"   The Orchestration service enables you to X and Y. Installation is"},{"line_number":95,"context_line":"   documented at"},{"line_number":96,"context_line":"   http://docs.openstack.org/project-install-guide/mitaka/orchestration ."},{"line_number":97,"context_line":""},{"line_number":98,"context_line":""},{"line_number":99,"context_line":"Docs.openstack.org index"}],"source_content_type":"text/x-rst","patch_set":7,"id":"9a061dce_2d408006","line":96,"updated":"2016-04-07 19:17:53.000000000","message":"From end-users point of view, it is confusing to see some projects have a *large* section and others projects have a *small* section.","commit_id":"486585cc11cbc4f98ebc48872e4f1026e498b2a7"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"9f691b2e1a2c05e92153901f017c7a424588c3da","unresolved":false,"context_lines":[{"line_number":93,"context_line":""},{"line_number":94,"context_line":"   The Orchestration service enables you to X and Y. Installation is"},{"line_number":95,"context_line":"   documented at"},{"line_number":96,"context_line":"   http://docs.openstack.org/project-install-guide/mitaka/orchestration ."},{"line_number":97,"context_line":""},{"line_number":98,"context_line":""},{"line_number":99,"context_line":"Docs.openstack.org index"}],"source_content_type":"text/x-rst","patch_set":7,"id":"9a061dce_ed332812","line":96,"in_reply_to":"9a061dce_2d408006","updated":"2016-04-07 19:30:35.000000000","message":"I do not get what you mean with small and large?","commit_id":"486585cc11cbc4f98ebc48872e4f1026e498b2a7"},{"author":{"_account_id":6816,"name":"Jesse Pretorius","email":"jesse@odyssey4.me","username":"jesse-pretorius"},"change_message_id":"89f3c63b4c55fd3a4bfa42f670d0919b3badcfd8","unresolved":false,"context_lines":[{"line_number":18,"context_line":"all projects in the install guide is not possible with the current"},{"line_number":19,"context_line":"size of the OpenStack documentation team."},{"line_number":20,"context_line":""},{"line_number":21,"context_line":"We therefore need to find a way that allows projects to write their"},{"line_number":22,"context_line":"own install guides without involvement of the documentation team -"},{"line_number":23,"context_line":"and the documentation team acting as enabler for these documents."},{"line_number":24,"context_line":""},{"line_number":25,"context_line":"An additional problem that has multiplied due to the Big Tent is the difficulty"}],"source_content_type":"text/x-rst","patch_set":10,"id":"1a122d0e_81cf867e","line":22,"range":{"start_line":21,"start_character":0,"end_line":22,"end_character":64},"updated":"2016-04-18 09:50:16.000000000","message":"I think that this is misleading. First, many projects already have their own install guides - this is already allowed. Second, what is needed is that the documentation team facilitates the improvement of the quality of the install guides - the content needs to be primarily maintained by the project in question while the docs team needs to take on a consultation and facilitation role instead of being the content producers.","commit_id":"27a073e182d3d434dd3b35a67279d79357af3d6e"},{"author":{"_account_id":6772,"name":"Stephen Gordon","email":"sgordon@redhat.com","username":"sgordon"},"change_message_id":"0bb0f523c3fc3c01eb5c49f2f941fdce28666b8b","unresolved":false,"context_lines":[{"line_number":22,"context_line":"own install guides without involvement of the documentation team -"},{"line_number":23,"context_line":"and the documentation team acting as enabler for these documents."},{"line_number":24,"context_line":""},{"line_number":25,"context_line":"An additional problem that has multiplied due to the Big Tent is the difficulty"},{"line_number":26,"context_line":"in testing multiple packaged distributions, and single-sourcing the content so"},{"line_number":27,"context_line":"that one set of source files can be built for four distributions: Debian, RHEL,"},{"line_number":28,"context_line":"SUSE, and Ubuntu. Also, packaged installations provide a single way to"},{"line_number":29,"context_line":"install OpenStack, but configuration management through deployment is the more"},{"line_number":30,"context_line":"common method for installing OpenStack in production."},{"line_number":31,"context_line":""},{"line_number":32,"context_line":"Proposed change"},{"line_number":33,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"}],"source_content_type":"text/x-rst","patch_set":10,"id":"5a18252c_ed47241b","line":30,"range":{"start_line":25,"start_character":0,"end_line":30,"end_character":53},"updated":"2016-04-13 16:30:21.000000000","message":"As Anne noted in an updated this part isn\u0027t really addressed in the current proposal, some thoughts further down near alternatives.\n\nA recurring challenge is that writers/reviewers tend to build a view of what is \"right\" based on their preferred/normal distribution and treat it as \"wrong\" when other distributions differ. Debian with debconf is the most prominent but similar issues have arisen with MySQL vs MariaDB, default conf values, conf file placement, etc.\n\nThe reality is if they were all the same then they wouldn\u0027t be different distributions but the problem as folks rightly point out is the conditionalization complicates the structure of the RST (just as it did the docbook before it). Realistically even if the most glaring example (debconf) is removed, there is always going to be some conditionalization in the current approach (and to be honest based on the current source, quite a bit of it). Is this a status quo we want to maintain or do we need to look at identifying approaches without conditionalization at all?","commit_id":"27a073e182d3d434dd3b35a67279d79357af3d6e"},{"author":{"_account_id":6816,"name":"Jesse Pretorius","email":"jesse@odyssey4.me","username":"jesse-pretorius"},"change_message_id":"89f3c63b4c55fd3a4bfa42f670d0919b3badcfd8","unresolved":false,"context_lines":[{"line_number":22,"context_line":"own install guides without involvement of the documentation team -"},{"line_number":23,"context_line":"and the documentation team acting as enabler for these documents."},{"line_number":24,"context_line":""},{"line_number":25,"context_line":"An additional problem that has multiplied due to the Big Tent is the difficulty"},{"line_number":26,"context_line":"in testing multiple packaged distributions, and single-sourcing the content so"},{"line_number":27,"context_line":"that one set of source files can be built for four distributions: Debian, RHEL,"},{"line_number":28,"context_line":"SUSE, and Ubuntu. Also, packaged installations provide a single way to"},{"line_number":29,"context_line":"install OpenStack, but configuration management through deployment is the more"},{"line_number":30,"context_line":"common method for installing OpenStack in production."},{"line_number":31,"context_line":""},{"line_number":32,"context_line":"Proposed change"},{"line_number":33,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"}],"source_content_type":"text/x-rst","patch_set":10,"id":"1a122d0e_e12e3af9","line":30,"range":{"start_line":25,"start_character":0,"end_line":30,"end_character":53},"in_reply_to":"5a18252c_ed47241b","updated":"2016-04-18 09:50:16.000000000","message":"All of this would be side-stepped if the primary content creation is handled by the projects which produce the packaged installations. For example, if the content for the .deb packaging install guide is produced by the same team as those preparing the packages, then there would be consistency.\n\nIn this type of scenario it would perhaps be best that the docs team provides a facilitative role in having all project teams agree on the end result(s) the install guide should produce. The deliverables agreed to should include something like the design of the resulting system, the structure of the content, the standards the content should adhere to, etc. Then the docs team plays a quality control role rather than a content producing role. The docs team then also plays a role in sharing best practices across projects, querying differences in implementations which are targeting the same end result, etc.","commit_id":"27a073e182d3d434dd3b35a67279d79357af3d6e"},{"author":{"_account_id":6816,"name":"Jesse Pretorius","email":"jesse@odyssey4.me","username":"jesse-pretorius"},"change_message_id":"89f3c63b4c55fd3a4bfa42f670d0919b3badcfd8","unresolved":false,"context_lines":[{"line_number":32,"context_line":"Proposed change"},{"line_number":33,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":34,"context_line":""},{"line_number":35,"context_line":"The basic install guide serves as a reference to reach the"},{"line_number":36,"context_line":"first step where administrators have all the underlying services like"},{"line_number":37,"context_line":"MySQL and RabbitMQ and a base set of functionality installed and"},{"line_number":38,"context_line":"working. It is essential for every reader of the guide to have a"},{"line_number":39,"context_line":"high-quality, proactively-checked, easy-to-understand content. The intent for"},{"line_number":40,"context_line":"a central, basic install guide is to train and orient readers so they can"},{"line_number":41,"context_line":"understand multiple OpenStack services while making informed decisions for"}],"source_content_type":"text/x-rst","patch_set":10,"id":"1a122d0e_c1821e94","line":38,"range":{"start_line":35,"start_character":0,"end_line":38,"end_character":8},"updated":"2016-04-18 09:50:16.000000000","message":"Note that deployment projects like OpenStack-Ansible cater for this implementation already. I find myself wondering, also, whether the install guides are a tool to evaluate OpenStack, or to install OpenStack for production use? This is something that is not clear to me and the question should be addressed as it has very far-reaching effects on how the documentation is put together.","commit_id":"27a073e182d3d434dd3b35a67279d79357af3d6e"},{"author":{"_account_id":6772,"name":"Stephen Gordon","email":"sgordon@redhat.com","username":"sgordon"},"change_message_id":"0bb0f523c3fc3c01eb5c49f2f941fdce28666b8b","unresolved":false,"context_lines":[{"line_number":41,"context_line":"understand multiple OpenStack services while making informed decisions for"},{"line_number":42,"context_line":"their situation."},{"line_number":43,"context_line":""},{"line_number":44,"context_line":"Then additional project-specific guides can be written that pick up"},{"line_number":45,"context_line":"from that base first step, assuming their readers have completed that"},{"line_number":46,"context_line":"first step successfully."},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"Ownership of the project specific install guides is with the"},{"line_number":49,"context_line":"respective project team, not the documentation team. This means the"}],"source_content_type":"text/x-rst","patch_set":10,"id":"5a18252c_0dcc2069","line":46,"range":{"start_line":44,"start_character":0,"end_line":46,"end_character":24},"updated":"2016-04-13 16:30:21.000000000","message":"Minor language quibble but really they should be project-specific chapters/sections that get dragged into the back of the \"one true install guide\" for publication no?\n\nMy concern is that positioning them as separate guides (rather than separate source which when joined with the central pieces constitutes a deliverable) prolongs the feeling that certain projects are not in the \"real\" guide.","commit_id":"27a073e182d3d434dd3b35a67279d79357af3d6e"},{"author":{"_account_id":6772,"name":"Stephen Gordon","email":"sgordon@redhat.com","username":"sgordon"},"change_message_id":"0bb0f523c3fc3c01eb5c49f2f941fdce28666b8b","unresolved":false,"context_lines":[{"line_number":46,"context_line":"first step successfully."},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"Ownership of the project specific install guides is with the"},{"line_number":49,"context_line":"respective project team, not the documentation team. This means the"},{"line_number":50,"context_line":"content is in an existing or new repository owned by the project team,"},{"line_number":51,"context_line":"reviews will be done by the project team, and bug reports will go in"},{"line_number":52,"context_line":"the bug queue of the project."},{"line_number":53,"context_line":""},{"line_number":54,"context_line":"The documentation team enables the project team to write the"},{"line_number":55,"context_line":"project specific guides with mentoring, setting up needed"}],"source_content_type":"text/x-rst","patch_set":10,"id":"5a18252c_4df45885","line":52,"range":{"start_line":49,"start_character":53,"end_line":52,"end_character":29},"updated":"2016-04-13 16:30:21.000000000","message":"I mention it further down but reviews by the project team and bugs triaged by same seem like good ideas for ALL sections, not just those outside the starter kit. Is there a way we can enable this even for those sections the docs team take more of an active role in developing/maintaining.","commit_id":"27a073e182d3d434dd3b35a67279d79357af3d6e"},{"author":{"_account_id":6816,"name":"Jesse Pretorius","email":"jesse@odyssey4.me","username":"jesse-pretorius"},"change_message_id":"89f3c63b4c55fd3a4bfa42f670d0919b3badcfd8","unresolved":false,"context_lines":[{"line_number":46,"context_line":"first step successfully."},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"Ownership of the project specific install guides is with the"},{"line_number":49,"context_line":"respective project team, not the documentation team. This means the"},{"line_number":50,"context_line":"content is in an existing or new repository owned by the project team,"},{"line_number":51,"context_line":"reviews will be done by the project team, and bug reports will go in"},{"line_number":52,"context_line":"the bug queue of the project."},{"line_number":53,"context_line":""},{"line_number":54,"context_line":"The documentation team enables the project team to write the"},{"line_number":55,"context_line":"project specific guides with mentoring, setting up needed"}],"source_content_type":"text/x-rst","patch_set":10,"id":"1a122d0e_a4e3b032","line":52,"range":{"start_line":49,"start_character":53,"end_line":52,"end_character":29},"in_reply_to":"5a18252c_4df45885","updated":"2016-04-18 09:50:16.000000000","message":"Agreed. The content production role should really switch to one being fulfilled by the project teams, not by docs teams. The docs teams should play a more consultative and facilitative role to improve the information architecture, quality and consistency of the documentation.\n\nWithin OpenStack-Ansible we have spent the Mitaka cycle focusing on ensuring that every patch includes documentation and release notes (where applicable). This has made a huge difference to the docs contribution rate. It does mean that the docs aren\u0027t always the best in quality or great from an information architecture standpoint, but there are at least docs and they can always be improved over time. From the OSA project standpoint this is a preferred place to be.","commit_id":"27a073e182d3d434dd3b35a67279d79357af3d6e"},{"author":{"_account_id":6816,"name":"Jesse Pretorius","email":"jesse@odyssey4.me","username":"jesse-pretorius"},"change_message_id":"89f3c63b4c55fd3a4bfa42f670d0919b3badcfd8","unresolved":false,"context_lines":[{"line_number":51,"context_line":"reviews will be done by the project team, and bug reports will go in"},{"line_number":52,"context_line":"the bug queue of the project."},{"line_number":53,"context_line":""},{"line_number":54,"context_line":"The documentation team enables the project team to write the"},{"line_number":55,"context_line":"project specific guides with mentoring, setting up needed"},{"line_number":56,"context_line":"infrastructure, writing of guidelines, providing a working base"},{"line_number":57,"context_line":"install guide that the project specific guides can use as"},{"line_number":58,"context_line":"reference."},{"line_number":59,"context_line":""},{"line_number":60,"context_line":""},{"line_number":61,"context_line":"Scope of basic install guide"}],"source_content_type":"text/x-rst","patch_set":10,"id":"1a122d0e_a4ba9008","line":58,"range":{"start_line":54,"start_character":0,"end_line":58,"end_character":10},"updated":"2016-04-18 09:50:16.000000000","message":"+1","commit_id":"27a073e182d3d434dd3b35a67279d79357af3d6e"},{"author":{"_account_id":6816,"name":"Jesse Pretorius","email":"jesse@odyssey4.me","username":"jesse-pretorius"},"change_message_id":"89f3c63b4c55fd3a4bfa42f670d0919b3badcfd8","unresolved":false,"context_lines":[{"line_number":64,"context_line":"The content of the basic install guide will cover the infrastructure and"},{"line_number":65,"context_line":"centralized projects that every cloud needs. This includes the projects defined"},{"line_number":66,"context_line":"as the"},{"line_number":67,"context_line":"`starter-kit:compute"},{"line_number":68,"context_line":"\u003chttp://governance.openstack.org/reference/tags/starter-kit_compute.html\u003e`__"},{"line_number":69,"context_line":"plus a few others:"},{"line_number":70,"context_line":""}],"source_content_type":"text/x-rst","patch_set":10,"id":"1a122d0e_84cb1453","line":67,"range":{"start_line":67,"start_character":1,"end_line":67,"end_character":20},"updated":"2016-04-18 09:50:16.000000000","message":"It may be a good idea to have some sort of reference/link to the Architecture guide. Essentially my thinking is that the Architecture guide covers a set of scenario\u0027s, then the install guides should provide a supporting role to the same scenario\u0027s, and the security guide should also play a supporting role to the same scenario\u0027s.\n\nSomehow we should figure out a way to have all the guides support each other and make reference to the same example design references in order to reduce confusion and maintain consistency. This is a lofty goal, probably very far into the future, but I think we should perhaps consider this as something to try out.","commit_id":"27a073e182d3d434dd3b35a67279d79357af3d6e"},{"author":{"_account_id":6772,"name":"Stephen Gordon","email":"sgordon@redhat.com","username":"sgordon"},"change_message_id":"0bb0f523c3fc3c01eb5c49f2f941fdce28666b8b","unresolved":false,"context_lines":[{"line_number":67,"context_line":"`starter-kit:compute"},{"line_number":68,"context_line":"\u003chttp://governance.openstack.org/reference/tags/starter-kit_compute.html\u003e`__"},{"line_number":69,"context_line":"plus a few others:"},{"line_number":70,"context_line":""},{"line_number":71,"context_line":"* Compute service (nova): Part of starter-kit:compute."},{"line_number":72,"context_line":"* Image service (glance): Part of starter-kit:compute."},{"line_number":73,"context_line":"* Identity service (keystone): Part of starter-kit:compute."},{"line_number":74,"context_line":"* Networking service (neutron): Part of starter-kit:compute."},{"line_number":75,"context_line":"* Block storage service (cinder): Part of current install guide and"},{"line_number":76,"context_line":"  expected by most users."},{"line_number":77,"context_line":"* Dashboard (horizon): Part of current install guide and expected by"},{"line_number":78,"context_line":"  most users."},{"line_number":79,"context_line":""},{"line_number":80,"context_line":"No further projects will be added to the guide unless they are"},{"line_number":81,"context_line":"required by one of the existing projects or generally required to run"}],"source_content_type":"text/x-rst","patch_set":10,"id":"5a18252c_5bf9b74c","line":78,"range":{"start_line":70,"start_character":0,"end_line":78,"end_character":13},"updated":"2016-04-13 16:30:21.000000000","message":"Assuming we come up with a framework that can pull all the content together, is there any reason not to also try and move the source for these sections to a closer to the projects themselves in the hope of getting more input from those teams. The main difference being that being in the defined scope the docs team would stay more involved in ownership/maintenance?","commit_id":"27a073e182d3d434dd3b35a67279d79357af3d6e"},{"author":{"_account_id":6816,"name":"Jesse Pretorius","email":"jesse@odyssey4.me","username":"jesse-pretorius"},"change_message_id":"89f3c63b4c55fd3a4bfa42f670d0919b3badcfd8","unresolved":false,"context_lines":[{"line_number":67,"context_line":"`starter-kit:compute"},{"line_number":68,"context_line":"\u003chttp://governance.openstack.org/reference/tags/starter-kit_compute.html\u003e`__"},{"line_number":69,"context_line":"plus a few others:"},{"line_number":70,"context_line":""},{"line_number":71,"context_line":"* Compute service (nova): Part of starter-kit:compute."},{"line_number":72,"context_line":"* Image service (glance): Part of starter-kit:compute."},{"line_number":73,"context_line":"* Identity service (keystone): Part of starter-kit:compute."},{"line_number":74,"context_line":"* Networking service (neutron): Part of starter-kit:compute."},{"line_number":75,"context_line":"* Block storage service (cinder): Part of current install guide and"},{"line_number":76,"context_line":"  expected by most users."},{"line_number":77,"context_line":"* Dashboard (horizon): Part of current install guide and expected by"},{"line_number":78,"context_line":"  most users."},{"line_number":79,"context_line":""},{"line_number":80,"context_line":"No further projects will be added to the guide unless they are"},{"line_number":81,"context_line":"required by one of the existing projects or generally required to run"}],"source_content_type":"text/x-rst","patch_set":10,"id":"1a122d0e_e42f683c","line":78,"range":{"start_line":70,"start_character":0,"end_line":78,"end_character":13},"in_reply_to":"5a18252c_5bf9b74c","updated":"2016-04-18 09:50:16.000000000","message":"+1 on the idea of moving the content closer to the teams and have them play more of a content production role","commit_id":"27a073e182d3d434dd3b35a67279d79357af3d6e"},{"author":{"_account_id":6772,"name":"Stephen Gordon","email":"sgordon@redhat.com","username":"sgordon"},"change_message_id":"0bb0f523c3fc3c01eb5c49f2f941fdce28666b8b","unresolved":false,"context_lines":[{"line_number":84,"context_line":"The documentation team updates and tests the basic install guide for"},{"line_number":85,"context_line":"each release."},{"line_number":86,"context_line":""},{"line_number":87,"context_line":"The install guide will be enhanced to link to additional project"},{"line_number":88,"context_line":"specific install guides. For this, it will have in a separate chapter"},{"line_number":89,"context_line":"for each official project a small section where each official project"},{"line_number":90,"context_line":"can give a short summary of their project together with a link to"},{"line_number":91,"context_line":"their own install guide. The chapter will also explain that all these"},{"line_number":92,"context_line":"projects are first-class citizien\u0027s of the bit tent of OpenStack."},{"line_number":93,"context_line":""},{"line_number":94,"context_line":"For example, Orchestration could store their install guide in the ``heat``"},{"line_number":95,"context_line":"repository, and publish to"}],"source_content_type":"text/x-rst","patch_set":10,"id":"5a18252c_0d042048","line":92,"range":{"start_line":87,"start_character":0,"end_line":92,"end_character":65},"updated":"2016-04-13 16:30:21.000000000","message":"This is a nice to have but is it feasible to build into a single \"guide\" with the content inline at least from a consumption perspective rather than use links? It seems to me like most of the solution relates to source organization/ownership and does not necessarily need to map to how output is built/displayed.","commit_id":"27a073e182d3d434dd3b35a67279d79357af3d6e"},{"author":{"_account_id":6772,"name":"Stephen Gordon","email":"sgordon@redhat.com","username":"sgordon"},"change_message_id":"0bb0f523c3fc3c01eb5c49f2f941fdce28666b8b","unresolved":false,"context_lines":[{"line_number":125,"context_line":"install guide architecture and as part of the \"enabling others\" part,"},{"line_number":126,"context_line":"the documentation team has some suggestions:"},{"line_number":127,"context_line":""},{"line_number":128,"context_line":"* We encourage projects to build on top of the existing install guide"},{"line_number":129,"context_line":"  architecture. This way the project team guide does not need to"},{"line_number":130,"context_line":"  document a full OpenStack setup including the basic host setup."},{"line_number":131,"context_line":"  Instead of reinventing the wheel, the project team guide can just"},{"line_number":132,"context_line":"  point out differences for the specific project."},{"line_number":133,"context_line":""},{"line_number":134,"context_line":"* We encourage projects to follow the documentation conventions as"},{"line_number":135,"context_line":"  written down in the `Documentation Contributor Guide"}],"source_content_type":"text/x-rst","patch_set":10,"id":"5a18252c_5be4173a","line":132,"range":{"start_line":128,"start_character":0,"end_line":132,"end_character":49},"updated":"2016-04-13 16:30:21.000000000","message":"Ideally with regards to this and the theming we should have a template for these that people can clone. I basically did this when I started trying to do Magnum docs by cloning the Glance chapter (as it is one of the more basic ones) - something like this with PLACEHOLDER values to get folks started as a base.","commit_id":"27a073e182d3d434dd3b35a67279d79357af3d6e"},{"author":{"_account_id":6772,"name":"Stephen Gordon","email":"sgordon@redhat.com","username":"sgordon"},"change_message_id":"0bb0f523c3fc3c01eb5c49f2f941fdce28666b8b","unresolved":false,"context_lines":[{"line_number":131,"context_line":"  Instead of reinventing the wheel, the project team guide can just"},{"line_number":132,"context_line":"  point out differences for the specific project."},{"line_number":133,"context_line":""},{"line_number":134,"context_line":"* We encourage projects to follow the documentation conventions as"},{"line_number":135,"context_line":"  written down in the `Documentation Contributor Guide"},{"line_number":136,"context_line":"  \u003chttp://docs.openstack.org/contributor-guide/\u003e`__."},{"line_number":137,"context_line":""},{"line_number":138,"context_line":"* We encourage projects to use the same theme (called"},{"line_number":139,"context_line":"  ``openstackdocstheme``) as the install guide."}],"source_content_type":"text/x-rst","patch_set":10,"id":"5a18252c_f0a0a245","line":136,"range":{"start_line":134,"start_character":0,"end_line":136,"end_character":52},"updated":"2016-04-13 16:30:21.000000000","message":"This is kind of tangential but I have a concern that changes to the conventions are barely communicated to the folks actively working in the docs project today let alone a broader group of folks. Someone has an opinion, adds it to the guide with two +2s and communication is via -1 of future changes.\n\nEven though the language here is soft, perhaps something we need to think about if we want to have the best chance of follow through esp. since folks who might have made said conventions updates likely wont be reviewing the guides split out to the individual projects.","commit_id":"27a073e182d3d434dd3b35a67279d79357af3d6e"},{"author":{"_account_id":6772,"name":"Stephen Gordon","email":"sgordon@redhat.com","username":"sgordon"},"change_message_id":"0bb0f523c3fc3c01eb5c49f2f941fdce28666b8b","unresolved":false,"context_lines":[{"line_number":159,"context_line":"----------"},{"line_number":160,"context_line":""},{"line_number":161,"context_line":"Project teams can publish their content to"},{"line_number":162,"context_line":"``docs.openstack.org/project-install-guide/RELEASE/SERVICE/ ``. ``RELEASE`` is"},{"line_number":163,"context_line":"the release like ``mitaka`` or ``newton``, ``SERVICE`` is the service"},{"line_number":164,"context_line":"name like ``orchestration``. For publishing from master, the"},{"line_number":165,"context_line":"``RELEASE`` should be ``draft``."}],"source_content_type":"text/x-rst","patch_set":10,"id":"5a18252c_8d64b022","line":162,"range":{"start_line":162,"start_character":2,"end_line":162,"end_character":59},"updated":"2016-04-13 16:30:21.000000000","message":"I kind of prefer docs.openstack.org/install-guide/project/release/service but in the grand scheme of things this is a nit...","commit_id":"27a073e182d3d434dd3b35a67279d79357af3d6e"},{"author":{"_account_id":6772,"name":"Stephen Gordon","email":"sgordon@redhat.com","username":"sgordon"},"change_message_id":"0bb0f523c3fc3c01eb5c49f2f941fdce28666b8b","unresolved":false,"context_lines":[{"line_number":170,"context_line":"Alternatives"},{"line_number":171,"context_line":"------------"},{"line_number":172,"context_line":""},{"line_number":173,"context_line":"* Packaged install guides separated out, with no single-sourced install guide:"},{"line_number":174,"context_line":"  each distribution publishes their own installation guide. These guides can"},{"line_number":175,"context_line":"  be published to docs.openstack.org/install or to a web domain they own,"},{"line_number":176,"context_line":"  sourced and reviewed from their own repositories with their teams. These"},{"line_number":177,"context_line":"  teams can set their own publishing schedule. This alternative solution"},{"line_number":178,"context_line":"  does not address the project teams needs, but alleviates the resource drain"},{"line_number":179,"context_line":"  on a centralized docs team."},{"line_number":180,"context_line":"* Stop writing package-based install guides in the OpenStack git namespace"},{"line_number":181,"context_line":"  entirely. Instead, have a central team write a starter-kit-based guide that"},{"line_number":182,"context_line":"  describes the multiple available deployment options and publish to"}],"source_content_type":"text/x-rst","patch_set":10,"id":"5a18252c_1ba0df8f","line":179,"range":{"start_line":173,"start_character":0,"end_line":179,"end_character":29},"updated":"2016-04-13 16:30:21.000000000","message":"We focus here on packages but the reality is distributions typically provide two things - packages and orchestrated deployment of some form.\n\nWe choose not to use the latter for the install guide based on the target audience (not re-hashing that here) but in terms of splitting up the guide something not addressed in this proposal at the moment is whether openstack-ansible, openstack-puppet, openstack-chef, fuel, tripleo, kolla docs should also be on the docs.openstack.org landing page (and some of these can use packages from multiple distributions). \n\nThese are all also big tent projects but suffer from the same perception problems that the other projects do which is \"you aren\u0027t on docs.o.o therefore you arent a real thing\" which is what is driving the requests for inclusion/","commit_id":"27a073e182d3d434dd3b35a67279d79357af3d6e"},{"author":{"_account_id":20156,"name":"Petr Kovar","email":"pkovar@redhat.com","username":"pmkovar"},"change_message_id":"49368bd893412f47827dd965ec68550b76479380","unresolved":false,"context_lines":[{"line_number":170,"context_line":"Alternatives"},{"line_number":171,"context_line":"------------"},{"line_number":172,"context_line":""},{"line_number":173,"context_line":"* Packaged install guides separated out, with no single-sourced install guide:"},{"line_number":174,"context_line":"  each distribution publishes their own installation guide. These guides can"},{"line_number":175,"context_line":"  be published to docs.openstack.org/install or to a web domain they own,"},{"line_number":176,"context_line":"  sourced and reviewed from their own repositories with their teams. These"},{"line_number":177,"context_line":"  teams can set their own publishing schedule. This alternative solution"},{"line_number":178,"context_line":"  does not address the project teams needs, but alleviates the resource drain"},{"line_number":179,"context_line":"  on a centralized docs team."},{"line_number":180,"context_line":"* Stop writing package-based install guides in the OpenStack git namespace"},{"line_number":181,"context_line":"  entirely. Instead, have a central team write a starter-kit-based guide that"},{"line_number":182,"context_line":"  describes the multiple available deployment options and publish to"}],"source_content_type":"text/x-rst","patch_set":10,"id":"1a122d0e_34fb2ac3","line":179,"range":{"start_line":173,"start_character":0,"end_line":179,"end_character":29},"in_reply_to":"1a122d0e_a4545021","updated":"2016-04-18 21:49:57.000000000","message":"+1 to what Stephen and Jesse said. \n\nI can\u0027t comment on other distributions, but I expect many RDO users to either go with Packstack for a proof-of-concept installation, or tripleo for a production-ready deployment. And I would love the information architecture of the Installation Guide(s) hosted on docs.o.o to be more consistent with those expectations. While the current Installation Guide states it also targets RDO users, we don\u0027t mention Packstack or tripleo in it -- the current structure doesn\u0027t quite allow for it. As a result, we are telling two very different stories on docs.o.o and rdoproject.org (or even docs.o.o/developer/).\n\nSo yes, looking at who the target audience really is and restructuring or splitting up the guide would help here. Also, various deployment tools with their own guides should be better advertised on docs.o.o I think.","commit_id":"27a073e182d3d434dd3b35a67279d79357af3d6e"},{"author":{"_account_id":6816,"name":"Jesse Pretorius","email":"jesse@odyssey4.me","username":"jesse-pretorius"},"change_message_id":"89f3c63b4c55fd3a4bfa42f670d0919b3badcfd8","unresolved":false,"context_lines":[{"line_number":170,"context_line":"Alternatives"},{"line_number":171,"context_line":"------------"},{"line_number":172,"context_line":""},{"line_number":173,"context_line":"* Packaged install guides separated out, with no single-sourced install guide:"},{"line_number":174,"context_line":"  each distribution publishes their own installation guide. These guides can"},{"line_number":175,"context_line":"  be published to docs.openstack.org/install or to a web domain they own,"},{"line_number":176,"context_line":"  sourced and reviewed from their own repositories with their teams. These"},{"line_number":177,"context_line":"  teams can set their own publishing schedule. This alternative solution"},{"line_number":178,"context_line":"  does not address the project teams needs, but alleviates the resource drain"},{"line_number":179,"context_line":"  on a centralized docs team."},{"line_number":180,"context_line":"* Stop writing package-based install guides in the OpenStack git namespace"},{"line_number":181,"context_line":"  entirely. Instead, have a central team write a starter-kit-based guide that"},{"line_number":182,"context_line":"  describes the multiple available deployment options and publish to"}],"source_content_type":"text/x-rst","patch_set":10,"id":"1a122d0e_a4545021","line":179,"range":{"start_line":173,"start_character":0,"end_line":179,"end_character":29},"in_reply_to":"5a18252c_1ba0df8f","updated":"2016-04-18 09:50:16.000000000","message":"To me this is really an issue of who the audience is for the install guide. In my mind an installer who installs packages by hand is someone evaluating and understand OpenStack - not someone implementing OpenStack for production usage. If anyone implements a production environment of OpenStack by hand, then I guess they\u0027re stuck in the 90\u0027s or something... and even then we did a ton of stuff using scripts instead of doing it all by hand. Doing things by hand does not scale beyond a handful of servers.\n\nSo I think we need to be clearer on presenting the options available and the audience for which the options are provided. Even many of the projects which provide production-ready, highly-available deployments also provide a simpler eval All-In-One system to try things out on.","commit_id":"27a073e182d3d434dd3b35a67279d79357af3d6e"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"b43b54e4a45d814393a0196343b9b69f9bfee28f","unresolved":false,"context_lines":[{"line_number":21,"context_line":"Additionally, it has become apparent through research and outreach that"},{"line_number":22,"context_line":"users, operators, and developers are consistently disappointed by our current"},{"line_number":23,"context_line":"Install Guide, for a number of other, but related, reasons. These tend to"},{"line_number":24,"context_line":"revolve around the document\u0027s lack of certain projects, as already mentioned,"},{"line_number":25,"context_line":"and the use of packaged installs, which is inconsistent with the way people"},{"line_number":26,"context_line":"install OpenStack in the real world."},{"line_number":27,"context_line":""},{"line_number":28,"context_line":"An additional problem that has multiplied due to the Big Tent is the difficulty"},{"line_number":29,"context_line":"in testing multiple packaged distributions, and single-sourcing the content so"}],"source_content_type":"text/x-rst","patch_set":12,"id":"1a122d0e_8546574d","line":26,"range":{"start_line":24,"start_character":0,"end_line":26,"end_character":36},"updated":"2016-04-23 18:18:59.000000000","message":"I disagree strongly. There are both camps.","commit_id":"e18da1ebb8ce9ddd6baf859aaa09a5f677c7bb68"},{"author":{"_account_id":167,"name":"Christian Berendt","email":"berendt@osism.tech","username":"berendt"},"change_message_id":"72229cd4e6d0aca226c9ff398d64c28efa64a48e","unresolved":false,"context_lines":[{"line_number":21,"context_line":"Additionally, it has become apparent through research and outreach that"},{"line_number":22,"context_line":"users, operators, and developers are consistently disappointed by our current"},{"line_number":23,"context_line":"Install Guide, for a number of other, but related, reasons. These tend to"},{"line_number":24,"context_line":"revolve around the document\u0027s lack of certain projects, as already mentioned,"},{"line_number":25,"context_line":"and the use of packaged installs, which is inconsistent with the way people"},{"line_number":26,"context_line":"install OpenStack in the real world."},{"line_number":27,"context_line":""},{"line_number":28,"context_line":"An additional problem that has multiplied due to the Big Tent is the difficulty"},{"line_number":29,"context_line":"in testing multiple packaged distributions, and single-sourcing the content so"}],"source_content_type":"text/x-rst","patch_set":12,"id":"1a122d0e_65e7bb12","line":26,"range":{"start_line":24,"start_character":0,"end_line":26,"end_character":36},"in_reply_to":"1a122d0e_8546574d","updated":"2016-04-23 19:42:40.000000000","message":"There are definitely both camps. In my POV it is not our job to provide documentation how to install OpenStack on top of a specific distribution using there provided packages. I think it makes our life easier only providing distribution specific instructions for shared services like RabbitMQ and MariaDB and to use a generic approach (installation from source) for everything else.","commit_id":"e18da1ebb8ce9ddd6baf859aaa09a5f677c7bb68"},{"author":{"_account_id":167,"name":"Christian Berendt","email":"berendt@osism.tech","username":"berendt"},"change_message_id":"72229cd4e6d0aca226c9ff398d64c28efa64a48e","unresolved":false,"context_lines":[{"line_number":42,"context_line":""},{"line_number":43,"context_line":"The basic install guide serves as a reference to reach the"},{"line_number":44,"context_line":"first step where administrators have all the underlying services like"},{"line_number":45,"context_line":"MySQL and RabbitMQ and a base set of functionality installed and"},{"line_number":46,"context_line":"working. It is essential for every reader of the guide to have a"},{"line_number":47,"context_line":"high-quality, proactively-checked, easy-to-understand content. The intent for"},{"line_number":48,"context_line":"a central, basic install guide is to train and orient readers so they can"}],"source_content_type":"text/x-rst","patch_set":12,"id":"1a122d0e_45e27f02","line":45,"range":{"start_line":45,"start_character":0,"end_line":45,"end_character":5},"updated":"2016-04-23 19:42:40.000000000","message":"We should use MariaDB here, we use MariaDB in the guide.","commit_id":"e18da1ebb8ce9ddd6baf859aaa09a5f677c7bb68"},{"author":{"_account_id":10897,"name":"Joseph Robinson","email":"josephremail@gmail.com","username":"RobiJoe"},"change_message_id":"4a62d3b35a38407db628a396d9c37dab5e19e4cd","unresolved":false,"context_lines":[{"line_number":55,"context_line":""},{"line_number":56,"context_line":"Ownership of the project specific install guides is with the"},{"line_number":57,"context_line":"respective project team, not the documentation team. This means the"},{"line_number":58,"context_line":"content is in an existing or new repository owned by the project team,"},{"line_number":59,"context_line":"reviews will be done by the project team, and bug reports will go in"},{"line_number":60,"context_line":"the bug queue of the project."},{"line_number":61,"context_line":""}],"source_content_type":"text/x-rst","patch_set":13,"id":"1a122d0e_330bf225","line":58,"updated":"2016-04-27 17:35:07.000000000","message":"Change comma to full stop here - \"..or a new repository owned by the project team. Project teams will review the project specific guides. Bug reports will go to project bug queues.\"","commit_id":"9a23bf98695f3dd6071c1177c987c2ce19366174"},{"author":{"_account_id":10897,"name":"Joseph Robinson","email":"josephremail@gmail.com","username":"RobiJoe"},"change_message_id":"4a62d3b35a38407db628a396d9c37dab5e19e4cd","unresolved":false,"context_lines":[{"line_number":97,"context_line":"for each official project a small section where each official project"},{"line_number":98,"context_line":"can give a short summary of their project together with a link to"},{"line_number":99,"context_line":"their own install guide. The chapter will also explain that all these"},{"line_number":100,"context_line":"projects are first-class citizien\u0027s of the bit tent of OpenStack."},{"line_number":101,"context_line":""},{"line_number":102,"context_line":"For example, Orchestration could store their install guide in the ``heat``"},{"line_number":103,"context_line":"repository, and publish to"}],"source_content_type":"text/x-rst","patch_set":13,"id":"1a122d0e_531dce60","line":100,"updated":"2016-04-27 17:35:07.000000000","message":"Remove apostrophe here, fix typo, change word order - \"..projects are first-class citizens of the Openstack big tent.\"","commit_id":"9a23bf98695f3dd6071c1177c987c2ce19366174"},{"author":{"_account_id":167,"name":"Christian Berendt","email":"berendt@osism.tech","username":"berendt"},"change_message_id":"c2421b302c43dfacf4052c0418df04d1149b0cae","unresolved":false,"context_lines":[{"line_number":217,"context_line":""},{"line_number":218,"context_line":"Assignee(s)"},{"line_number":219,"context_line":"-----------"},{"line_number":220,"context_line":""},{"line_number":221,"context_line":""},{"line_number":222,"context_line":"Work Items"},{"line_number":223,"context_line":"----------"}],"source_content_type":"text/x-rst","patch_set":13,"id":"1a122d0e_882615cc","line":220,"updated":"2016-04-27 17:31:19.000000000","message":"Lane will take the TL of the install guide.","commit_id":"9a23bf98695f3dd6071c1177c987c2ce19366174"},{"author":{"_account_id":167,"name":"Christian Berendt","email":"berendt@osism.tech","username":"berendt"},"change_message_id":"7ee929b7673e239babc8c3590e5e5f30562184e7","unresolved":false,"context_lines":[{"line_number":241,"context_line":"* Work with operator tags team to amend the `ops:docs:install-guide tag"},{"line_number":242,"context_line":"  \u003chttp://git.openstack.org/cgit/openstack/ops-tags-team/tree/descriptions/ops-docs-install-guide.rst\u003e`_"},{"line_number":243,"context_line":"  (thingee)"},{"line_number":244,"context_line":""},{"line_number":245,"context_line":"Dependencies"},{"line_number":246,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":247,"context_line":""}],"source_content_type":"text/x-rst","patch_set":13,"id":"1a122d0e_883bb5d0","line":244,"updated":"2016-04-27 16:59:53.000000000","message":"Create a cookie cutter template that can be used as a base for project specific install guides.","commit_id":"9a23bf98695f3dd6071c1177c987c2ce19366174"},{"author":{"_account_id":167,"name":"Christian Berendt","email":"berendt@osism.tech","username":"berendt"},"change_message_id":"beda055ac0d14c3d935376fc7ad3fa1acdc0c040","unresolved":false,"context_lines":[{"line_number":241,"context_line":"* Work with operator tags team to amend the `ops:docs:install-guide tag"},{"line_number":242,"context_line":"  \u003chttp://git.openstack.org/cgit/openstack/ops-tags-team/tree/descriptions/ops-docs-install-guide.rst\u003e`_"},{"line_number":243,"context_line":"  (thingee)"},{"line_number":244,"context_line":""},{"line_number":245,"context_line":"Dependencies"},{"line_number":246,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":247,"context_line":""}],"source_content_type":"text/x-rst","patch_set":13,"id":"1a122d0e_880d7540","line":244,"in_reply_to":"1a122d0e_0838459f","updated":"2016-04-27 17:31:52.000000000","message":"I think we do not have a existing template that can be tweaked?","commit_id":"9a23bf98695f3dd6071c1177c987c2ce19366174"},{"author":{"_account_id":7007,"name":"Pranav Salunke","email":"dguitarbite@gmail.com","username":"dguitarbite"},"change_message_id":"ad24d139484d453069e048e7cac38cdee4f2fc67","unresolved":false,"context_lines":[{"line_number":241,"context_line":"* Work with operator tags team to amend the `ops:docs:install-guide tag"},{"line_number":242,"context_line":"  \u003chttp://git.openstack.org/cgit/openstack/ops-tags-team/tree/descriptions/ops-docs-install-guide.rst\u003e`_"},{"line_number":243,"context_line":"  (thingee)"},{"line_number":244,"context_line":""},{"line_number":245,"context_line":"Dependencies"},{"line_number":246,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":247,"context_line":""}],"source_content_type":"text/x-rst","patch_set":13,"id":"1a122d0e_0838459f","line":244,"in_reply_to":"1a122d0e_883bb5d0","updated":"2016-04-27 17:08:39.000000000","message":"I agree. We should have a cookie cutter template or tweak existing one based on the outcome of this spec.","commit_id":"9a23bf98695f3dd6071c1177c987c2ce19366174"}]}