)]}'
{"specs/policy/release-note-management.rst":[{"author":{"_account_id":8688,"name":"Alexis Lee","email":"openstack@lxsli.co.uk","username":"lxsli"},"change_message_id":"d5468c61abe8481330393817076d7d088a8f71ea","unresolved":false,"context_lines":[{"line_number":8,"context_line":"Problem Description"},{"line_number":9,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":10,"context_line":""},{"line_number":11,"context_line":"Oslo libraries have several potential audiences"},{"line_number":12,"context_line":""},{"line_number":13,"context_line":"* OpenStack service developers"},{"line_number":14,"context_line":"* OpenStack deployers"}],"source_content_type":"text/x-rst","patch_set":1,"id":"bae84128_73f58d55","line":11,"updated":"2016-02-23 10:36:42.000000000","message":"nit: lists should be introduced with a colon","commit_id":"29a87f341f06d59994213e0772b1dc6e006d1f7b"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"a31711f1072343d4a3ea67a4a7c6ab022a60a400","unresolved":false,"context_lines":[{"line_number":8,"context_line":"Problem Description"},{"line_number":9,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":10,"context_line":""},{"line_number":11,"context_line":"Oslo libraries have several potential audiences"},{"line_number":12,"context_line":""},{"line_number":13,"context_line":"* OpenStack service developers"},{"line_number":14,"context_line":"* OpenStack deployers"}],"source_content_type":"text/x-rst","patch_set":1,"id":"bae84128_0c67b8e9","line":11,"in_reply_to":"bae84128_73f58d55","updated":"2016-02-23 14:16:47.000000000","message":"Done","commit_id":"29a87f341f06d59994213e0772b1dc6e006d1f7b"},{"author":{"_account_id":8688,"name":"Alexis Lee","email":"openstack@lxsli.co.uk","username":"lxsli"},"change_message_id":"d5468c61abe8481330393817076d7d088a8f71ea","unresolved":false,"context_lines":[{"line_number":28,"context_line":""},{"line_number":29,"context_line":"The packaging library pbr includes a facility for automatically"},{"line_number":30,"context_line":"generating a ChangeLog file based on the git history for the project"},{"line_number":31,"context_line":"being packaged. That file is reStructuredText, and can be included"},{"line_number":32,"context_line":"directly in the developer documentation compiled by Sphinx into HTML"},{"line_number":33,"context_line":"and published under http://docs.openstack.org/developer/."},{"line_number":34,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"bae84128_f3887dc7","line":31,"range":{"start_line":31,"start_character":51,"end_line":31,"end_character":54},"updated":"2016-02-23 10:36:42.000000000","message":"s/can/should/ ?","commit_id":"29a87f341f06d59994213e0772b1dc6e006d1f7b"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"a31711f1072343d4a3ea67a4a7c6ab022a60a400","unresolved":false,"context_lines":[{"line_number":28,"context_line":""},{"line_number":29,"context_line":"The packaging library pbr includes a facility for automatically"},{"line_number":30,"context_line":"generating a ChangeLog file based on the git history for the project"},{"line_number":31,"context_line":"being packaged. That file is reStructuredText, and can be included"},{"line_number":32,"context_line":"directly in the developer documentation compiled by Sphinx into HTML"},{"line_number":33,"context_line":"and published under http://docs.openstack.org/developer/."},{"line_number":34,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"bae84128_6c6004d0","line":31,"range":{"start_line":31,"start_character":51,"end_line":31,"end_character":54},"in_reply_to":"bae84128_f3887dc7","updated":"2016-02-23 14:16:47.000000000","message":"Done","commit_id":"29a87f341f06d59994213e0772b1dc6e006d1f7b"},{"author":{"_account_id":8688,"name":"Alexis Lee","email":"openstack@lxsli.co.uk","username":"lxsli"},"change_message_id":"d5468c61abe8481330393817076d7d088a8f71ea","unresolved":false,"context_lines":[{"line_number":33,"context_line":"and published under http://docs.openstack.org/developer/."},{"line_number":34,"context_line":""},{"line_number":35,"context_line":"Additional information for developers can be added directly to the"},{"line_number":36,"context_line":"developer documentation. Docstrings in code can be annotated with the"},{"line_number":37,"context_line":"versions when new features or parameters were added to make it easy to"},{"line_number":38,"context_line":"understand which version of a library is needed in order to use a"},{"line_number":39,"context_line":"capability."}],"source_content_type":"text/x-rst","patch_set":1,"id":"bae84128_98d2f05a","line":36,"range":{"start_line":36,"start_character":44,"end_line":36,"end_character":47},"updated":"2016-02-23 10:36:42.000000000","message":"s/can/must/ ?","commit_id":"29a87f341f06d59994213e0772b1dc6e006d1f7b"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"a31711f1072343d4a3ea67a4a7c6ab022a60a400","unresolved":false,"context_lines":[{"line_number":33,"context_line":"and published under http://docs.openstack.org/developer/."},{"line_number":34,"context_line":""},{"line_number":35,"context_line":"Additional information for developers can be added directly to the"},{"line_number":36,"context_line":"developer documentation. Docstrings in code can be annotated with the"},{"line_number":37,"context_line":"versions when new features or parameters were added to make it easy to"},{"line_number":38,"context_line":"understand which version of a library is needed in order to use a"},{"line_number":39,"context_line":"capability."}],"source_content_type":"text/x-rst","patch_set":1,"id":"bae84128_4c5d4014","line":36,"range":{"start_line":36,"start_character":44,"end_line":36,"end_character":47},"in_reply_to":"bae84128_98d2f05a","updated":"2016-02-23 14:16:47.000000000","message":"Done","commit_id":"29a87f341f06d59994213e0772b1dc6e006d1f7b"},{"author":{"_account_id":8688,"name":"Alexis Lee","email":"openstack@lxsli.co.uk","username":"lxsli"},"change_message_id":"d5468c61abe8481330393817076d7d088a8f71ea","unresolved":false,"context_lines":[{"line_number":34,"context_line":""},{"line_number":35,"context_line":"Additional information for developers can be added directly to the"},{"line_number":36,"context_line":"developer documentation. Docstrings in code can be annotated with the"},{"line_number":37,"context_line":"versions when new features or parameters were added to make it easy to"},{"line_number":38,"context_line":"understand which version of a library is needed in order to use a"},{"line_number":39,"context_line":"capability."},{"line_number":40,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"bae84128_f3afdd27","line":37,"range":{"start_line":37,"start_character":41,"end_line":37,"end_character":45},"updated":"2016-02-23 10:36:42.000000000","message":"s/were/are/, mixed tense","commit_id":"29a87f341f06d59994213e0772b1dc6e006d1f7b"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"a31711f1072343d4a3ea67a4a7c6ab022a60a400","unresolved":false,"context_lines":[{"line_number":34,"context_line":""},{"line_number":35,"context_line":"Additional information for developers can be added directly to the"},{"line_number":36,"context_line":"developer documentation. Docstrings in code can be annotated with the"},{"line_number":37,"context_line":"versions when new features or parameters were added to make it easy to"},{"line_number":38,"context_line":"understand which version of a library is needed in order to use a"},{"line_number":39,"context_line":"capability."},{"line_number":40,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"bae84128_ac9cccc0","line":37,"range":{"start_line":37,"start_character":41,"end_line":37,"end_character":45},"in_reply_to":"bae84128_f3afdd27","updated":"2016-02-23 14:16:47.000000000","message":"Done","commit_id":"29a87f341f06d59994213e0772b1dc6e006d1f7b"},{"author":{"_account_id":8688,"name":"Alexis Lee","email":"openstack@lxsli.co.uk","username":"lxsli"},"change_message_id":"d5468c61abe8481330393817076d7d088a8f71ea","unresolved":false,"context_lines":[{"line_number":36,"context_line":"developer documentation. Docstrings in code can be annotated with the"},{"line_number":37,"context_line":"versions when new features or parameters were added to make it easy to"},{"line_number":38,"context_line":"understand which version of a library is needed in order to use a"},{"line_number":39,"context_line":"capability."},{"line_number":40,"context_line":""},{"line_number":41,"context_line":"Release notes for deployers should be managed through reno and"},{"line_number":42,"context_line":"published under http://docs.openstack.org/releasenotes/. Each library"}],"source_content_type":"text/x-rst","patch_set":1,"id":"bae84128_d339f9f3","line":39,"updated":"2016-02-23 10:36:42.000000000","message":"This sentence could be shortened to:\n\n  Docstrings for new features and parameters must be\n  annotated with versions to make it easy to understand\n  when the feature became available.","commit_id":"29a87f341f06d59994213e0772b1dc6e006d1f7b"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"a31711f1072343d4a3ea67a4a7c6ab022a60a400","unresolved":false,"context_lines":[{"line_number":36,"context_line":"developer documentation. Docstrings in code can be annotated with the"},{"line_number":37,"context_line":"versions when new features or parameters were added to make it easy to"},{"line_number":38,"context_line":"understand which version of a library is needed in order to use a"},{"line_number":39,"context_line":"capability."},{"line_number":40,"context_line":""},{"line_number":41,"context_line":"Release notes for deployers should be managed through reno and"},{"line_number":42,"context_line":"published under http://docs.openstack.org/releasenotes/. Each library"}],"source_content_type":"text/x-rst","patch_set":1,"id":"bae84128_8ca108fb","line":39,"in_reply_to":"bae84128_d339f9f3","updated":"2016-02-23 14:16:47.000000000","message":"Done","commit_id":"29a87f341f06d59994213e0772b1dc6e006d1f7b"},{"author":{"_account_id":16051,"name":"Ronald Bradford","email":"ronald.bradford@gmail.com","username":"ronaldbradford"},"change_message_id":"fb4883391381f38fa999a4410e5b915e3f8a75e2","unresolved":false,"context_lines":[{"line_number":38,"context_line":"understand which version of a library is needed in order to use a"},{"line_number":39,"context_line":"capability."},{"line_number":40,"context_line":""},{"line_number":41,"context_line":"Release notes for deployers should be managed through reno and"},{"line_number":42,"context_line":"published under http://docs.openstack.org/releasenotes/. Each library"},{"line_number":43,"context_line":"with configuration options or other deployer-facing interfaces should"},{"line_number":44,"context_line":"set up reno to publish release notes. Not all Oslo libraries will need"}],"source_content_type":"text/x-rst","patch_set":1,"id":"bae84128_370ca7ec","line":41,"updated":"2016-02-23 14:50:29.000000000","message":"Does it pay to reference the developer documentation of reno http://docs.openstack.org/developer/reno/ as people may be unfamiliar with this project.  This is the first reference to reno.","commit_id":"29a87f341f06d59994213e0772b1dc6e006d1f7b"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"a6c2439635b54008d4fc2eacbb4f8c3ec9a651eb","unresolved":false,"context_lines":[{"line_number":38,"context_line":"understand which version of a library is needed in order to use a"},{"line_number":39,"context_line":"capability."},{"line_number":40,"context_line":""},{"line_number":41,"context_line":"Release notes for deployers should be managed through reno and"},{"line_number":42,"context_line":"published under http://docs.openstack.org/releasenotes/. Each library"},{"line_number":43,"context_line":"with configuration options or other deployer-facing interfaces should"},{"line_number":44,"context_line":"set up reno to publish release notes. Not all Oslo libraries will need"}],"source_content_type":"text/x-rst","patch_set":1,"id":"bae84128_fe894827","line":41,"in_reply_to":"bae84128_370ca7ec","updated":"2016-02-23 18:48:46.000000000","message":"Done","commit_id":"29a87f341f06d59994213e0772b1dc6e006d1f7b"},{"author":{"_account_id":16051,"name":"Ronald Bradford","email":"ronald.bradford@gmail.com","username":"ronaldbradford"},"change_message_id":"fb4883391381f38fa999a4410e5b915e3f8a75e2","unresolved":false,"context_lines":[{"line_number":39,"context_line":"capability."},{"line_number":40,"context_line":""},{"line_number":41,"context_line":"Release notes for deployers should be managed through reno and"},{"line_number":42,"context_line":"published under http://docs.openstack.org/releasenotes/. Each library"},{"line_number":43,"context_line":"with configuration options or other deployer-facing interfaces should"},{"line_number":44,"context_line":"set up reno to publish release notes. Not all Oslo libraries will need"},{"line_number":45,"context_line":"to do that."}],"source_content_type":"text/x-rst","patch_set":1,"id":"bae84128_97249360","line":42,"updated":"2016-02-23 14:50:29.000000000","message":"This link is a 403?","commit_id":"29a87f341f06d59994213e0772b1dc6e006d1f7b"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"a6c2439635b54008d4fc2eacbb4f8c3ec9a651eb","unresolved":false,"context_lines":[{"line_number":39,"context_line":"capability."},{"line_number":40,"context_line":""},{"line_number":41,"context_line":"Release notes for deployers should be managed through reno and"},{"line_number":42,"context_line":"published under http://docs.openstack.org/releasenotes/. Each library"},{"line_number":43,"context_line":"with configuration options or other deployer-facing interfaces should"},{"line_number":44,"context_line":"set up reno to publish release notes. Not all Oslo libraries will need"},{"line_number":45,"context_line":"to do that."}],"source_content_type":"text/x-rst","patch_set":1,"id":"bae84128_1e9cec5b","line":42,"in_reply_to":"bae84128_97249360","updated":"2016-02-23 18:48:46.000000000","message":"Yes, that\u0027s the location under which individual projects publish their notes to URLs like http://docs.openstack.org/releasenotes/oslo.config/. The list of projects is maintained on releases.openstack.org.","commit_id":"29a87f341f06d59994213e0772b1dc6e006d1f7b"},{"author":{"_account_id":8688,"name":"Alexis Lee","email":"openstack@lxsli.co.uk","username":"lxsli"},"change_message_id":"d5468c61abe8481330393817076d7d088a8f71ea","unresolved":false,"context_lines":[{"line_number":41,"context_line":"Release notes for deployers should be managed through reno and"},{"line_number":42,"context_line":"published under http://docs.openstack.org/releasenotes/. Each library"},{"line_number":43,"context_line":"with configuration options or other deployer-facing interfaces should"},{"line_number":44,"context_line":"set up reno to publish release notes. Not all Oslo libraries will need"},{"line_number":45,"context_line":"to do that."},{"line_number":46,"context_line":""},{"line_number":47,"context_line":"The deployer-facing release notes should be written with them in mind,"}],"source_content_type":"text/x-rst","patch_set":1,"id":"bae84128_2e19de79","line":44,"range":{"start_line":44,"start_character":46,"end_line":44,"end_character":50},"updated":"2016-02-23 10:36:42.000000000","message":"s/Oslo// ?","commit_id":"29a87f341f06d59994213e0772b1dc6e006d1f7b"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"a31711f1072343d4a3ea67a4a7c6ab022a60a400","unresolved":false,"context_lines":[{"line_number":41,"context_line":"Release notes for deployers should be managed through reno and"},{"line_number":42,"context_line":"published under http://docs.openstack.org/releasenotes/. Each library"},{"line_number":43,"context_line":"with configuration options or other deployer-facing interfaces should"},{"line_number":44,"context_line":"set up reno to publish release notes. Not all Oslo libraries will need"},{"line_number":45,"context_line":"to do that."},{"line_number":46,"context_line":""},{"line_number":47,"context_line":"The deployer-facing release notes should be written with them in mind,"}],"source_content_type":"text/x-rst","patch_set":1,"id":"bae84128_6cb7643a","line":44,"range":{"start_line":44,"start_character":46,"end_line":44,"end_character":50},"in_reply_to":"bae84128_2e19de79","updated":"2016-02-23 14:16:47.000000000","message":"The policy only applies to Oslo, at least for now.","commit_id":"29a87f341f06d59994213e0772b1dc6e006d1f7b"},{"author":{"_account_id":8688,"name":"Alexis Lee","email":"openstack@lxsli.co.uk","username":"lxsli"},"change_message_id":"d5468c61abe8481330393817076d7d088a8f71ea","unresolved":false,"context_lines":[{"line_number":51,"context_line":"visible to the deployer. Changes to configuration options or file"},{"line_number":52,"context_line":"formats should have reno notes. Changes to internal APIs do not need"},{"line_number":53,"context_line":"them. New features of the library, or bug fixes such as better timeout"},{"line_number":54,"context_line":"handling or reconnection management for messaging or database services"},{"line_number":55,"context_line":"should be documented with reno release notes."},{"line_number":56,"context_line":""},{"line_number":57,"context_line":"Alternatives \u0026 History"}],"source_content_type":"text/x-rst","patch_set":1,"id":"bae84128_ae716eaa","line":54,"updated":"2016-02-23 10:36:42.000000000","message":"nit: might read better as \"New features of the library or bug fixes (EG better timeout\nhandling, reconnection management for messaging or database services) should be documented with reno release notes.\"","commit_id":"29a87f341f06d59994213e0772b1dc6e006d1f7b"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"a31711f1072343d4a3ea67a4a7c6ab022a60a400","unresolved":false,"context_lines":[{"line_number":51,"context_line":"visible to the deployer. Changes to configuration options or file"},{"line_number":52,"context_line":"formats should have reno notes. Changes to internal APIs do not need"},{"line_number":53,"context_line":"them. New features of the library, or bug fixes such as better timeout"},{"line_number":54,"context_line":"handling or reconnection management for messaging or database services"},{"line_number":55,"context_line":"should be documented with reno release notes."},{"line_number":56,"context_line":""},{"line_number":57,"context_line":"Alternatives \u0026 History"}],"source_content_type":"text/x-rst","patch_set":1,"id":"bae84128_ac832c55","line":54,"in_reply_to":"bae84128_ae716eaa","updated":"2016-02-23 14:16:47.000000000","message":"Done","commit_id":"29a87f341f06d59994213e0772b1dc6e006d1f7b"},{"author":{"_account_id":16051,"name":"Ronald Bradford","email":"ronald.bradford@gmail.com","username":"ronaldbradford"},"change_message_id":"fb4883391381f38fa999a4410e5b915e3f8a75e2","unresolved":false,"context_lines":[{"line_number":65,"context_line":"We could add a section to the developer documentation, but this will"},{"line_number":66,"context_line":"make it more difficult to build a single set of release notes for all"},{"line_number":67,"context_line":"of OpenStack, or at the very least link directly to release notes in a"},{"line_number":68,"context_line":"location common to all projects."},{"line_number":69,"context_line":""},{"line_number":70,"context_line":"Implementation"},{"line_number":71,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"}],"source_content_type":"text/x-rst","patch_set":1,"id":"bae84128_d77e1b18","line":68,"updated":"2016-02-23 14:50:29.000000000","message":"You should also reference that alternatives docs include the OpenStack documentation includes Installation, Configuration and Administration guides exist.  \n\nThese do not contain developer specific information, but may need to also include deployer information when applicable.","commit_id":"29a87f341f06d59994213e0772b1dc6e006d1f7b"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"a6c2439635b54008d4fc2eacbb4f8c3ec9a651eb","unresolved":false,"context_lines":[{"line_number":65,"context_line":"We could add a section to the developer documentation, but this will"},{"line_number":66,"context_line":"make it more difficult to build a single set of release notes for all"},{"line_number":67,"context_line":"of OpenStack, or at the very least link directly to release notes in a"},{"line_number":68,"context_line":"location common to all projects."},{"line_number":69,"context_line":""},{"line_number":70,"context_line":"Implementation"},{"line_number":71,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"}],"source_content_type":"text/x-rst","patch_set":1,"id":"bae84128_3eae1081","line":68,"in_reply_to":"bae84128_d77e1b18","updated":"2016-02-23 18:48:46.000000000","message":"They don\u0027t contain release notes, though.","commit_id":"29a87f341f06d59994213e0772b1dc6e006d1f7b"}]}
