)]}'
{"doc/source/developer-docs/contribute.rst":[{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"8f9e23bf471619f13c1f5bacf20844177198b7e2","unresolved":false,"context_lines":[{"line_number":165,"context_line":"* To understand the changes in the project over time which may affect an existing"},{"line_number":166,"context_line":"  deployment."},{"line_number":167,"context_line":""},{"line_number":168,"context_line":"To meet these needs developers must employ the use of documentation and release notes"},{"line_number":169,"context_line":"which should be submitted along with any code submissions. All forms of documentation"},{"line_number":170,"context_line":"should comply with the guidelines provided in the `OpenStack Documentation Contributor"},{"line_number":171,"context_line":"Guide`_, with particular reference to the following sections:"}],"source_content_type":"text/x-rst","patch_set":1,"id":"dab17558_5757f701","line":168,"updated":"2016-05-13 12:39:55.000000000","message":"\"The meet these needs, developers must submit documentation and release notes with any code submissions.\"","commit_id":"c5816968f0de3f0109724e3e4c76d850500f2afd"},{"author":{"_account_id":6816,"name":"Jesse Pretorius","email":"jesse@odyssey4.me","username":"jesse-pretorius"},"change_message_id":"a86c7874123ea508337d49a8154050c223bcdf37","unresolved":false,"context_lines":[{"line_number":165,"context_line":"* To understand the changes in the project over time which may affect an existing"},{"line_number":166,"context_line":"  deployment."},{"line_number":167,"context_line":""},{"line_number":168,"context_line":"To meet these needs developers must employ the use of documentation and release notes"},{"line_number":169,"context_line":"which should be submitted along with any code submissions. All forms of documentation"},{"line_number":170,"context_line":"should comply with the guidelines provided in the `OpenStack Documentation Contributor"},{"line_number":171,"context_line":"Guide`_, with particular reference to the following sections:"}],"source_content_type":"text/x-rst","patch_set":1,"id":"dab17558_a0eb7611","line":168,"range":{"start_line":168,"start_character":54,"end_line":168,"end_character":85},"updated":"2016-05-13 13:58:20.000000000","message":"I should also note code comments here.","commit_id":"c5816968f0de3f0109724e3e4c76d850500f2afd"},{"author":{"_account_id":6816,"name":"Jesse Pretorius","email":"jesse@odyssey4.me","username":"jesse-pretorius"},"change_message_id":"cce4731848e59f22ff210d47e918b62b7b3233c3","unresolved":false,"context_lines":[{"line_number":165,"context_line":"* To understand the changes in the project over time which may affect an existing"},{"line_number":166,"context_line":"  deployment."},{"line_number":167,"context_line":""},{"line_number":168,"context_line":"To meet these needs developers must employ the use of documentation and release notes"},{"line_number":169,"context_line":"which should be submitted along with any code submissions. All forms of documentation"},{"line_number":170,"context_line":"should comply with the guidelines provided in the `OpenStack Documentation Contributor"},{"line_number":171,"context_line":"Guide`_, with particular reference to the following sections:"}],"source_content_type":"text/x-rst","patch_set":1,"id":"dab17558_b7710347","line":168,"in_reply_to":"dab17558_5757f701","updated":"2016-05-13 12:43:39.000000000","message":"I\u0027ll fix that.","commit_id":"c5816968f0de3f0109724e3e4c76d850500f2afd"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"a76da07745bcaeba363bf8a6101a9c22cfd7947c","unresolved":false,"context_lines":[{"line_number":165,"context_line":"* To understand the changes in the project over time which may affect an existing"},{"line_number":166,"context_line":"  deployment."},{"line_number":167,"context_line":""},{"line_number":168,"context_line":"To meet these needs developers must employ the use of documentation and release notes"},{"line_number":169,"context_line":"which should be submitted along with any code submissions. All forms of documentation"},{"line_number":170,"context_line":"should comply with the guidelines provided in the `OpenStack Documentation Contributor"},{"line_number":171,"context_line":"Guide`_, with particular reference to the following sections:"}],"source_content_type":"text/x-rst","patch_set":1,"id":"dab17558_eb255f5c","line":168,"range":{"start_line":168,"start_character":54,"end_line":168,"end_character":85},"in_reply_to":"dab17558_a0eb7611","updated":"2016-05-13 14:15:46.000000000","message":"Yeah I think that\u0027s a good idea. I\u0027d like to see what you come up with first though :)","commit_id":"c5816968f0de3f0109724e3e4c76d850500f2afd"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"8f9e23bf471619f13c1f5bacf20844177198b7e2","unresolved":false,"context_lines":[{"line_number":167,"context_line":""},{"line_number":168,"context_line":"To meet these needs developers must employ the use of documentation and release notes"},{"line_number":169,"context_line":"which should be submitted along with any code submissions. All forms of documentation"},{"line_number":170,"context_line":"should comply with the guidelines provided in the `OpenStack Documentation Contributor"},{"line_number":171,"context_line":"Guide`_, with particular reference to the following sections:"},{"line_number":172,"context_line":""},{"line_number":173,"context_line":"* Writing style"},{"line_number":174,"context_line":"* RST formatting conventions"}],"source_content_type":"text/x-rst","patch_set":1,"id":"dab17558_372353a9","line":171,"range":{"start_line":170,"start_character":50,"end_line":171,"end_character":7},"updated":"2016-05-13 12:39:55.000000000","message":"This should be a link to: http://docs.openstack.org/contributor-guide/index.html","commit_id":"c5816968f0de3f0109724e3e4c76d850500f2afd"},{"author":{"_account_id":6816,"name":"Jesse Pretorius","email":"jesse@odyssey4.me","username":"jesse-pretorius"},"change_message_id":"cce4731848e59f22ff210d47e918b62b7b3233c3","unresolved":false,"context_lines":[{"line_number":167,"context_line":""},{"line_number":168,"context_line":"To meet these needs developers must employ the use of documentation and release notes"},{"line_number":169,"context_line":"which should be submitted along with any code submissions. All forms of documentation"},{"line_number":170,"context_line":"should comply with the guidelines provided in the `OpenStack Documentation Contributor"},{"line_number":171,"context_line":"Guide`_, with particular reference to the following sections:"},{"line_number":172,"context_line":""},{"line_number":173,"context_line":"* Writing style"},{"line_number":174,"context_line":"* RST formatting conventions"}],"source_content_type":"text/x-rst","patch_set":1,"id":"dab17558_97f95fcb","line":171,"range":{"start_line":170,"start_character":50,"end_line":171,"end_character":7},"in_reply_to":"dab17558_372353a9","updated":"2016-05-13 12:43:39.000000000","message":"It does - look at the end of the section for the link.","commit_id":"c5816968f0de3f0109724e3e4c76d850500f2afd"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"a76da07745bcaeba363bf8a6101a9c22cfd7947c","unresolved":false,"context_lines":[{"line_number":167,"context_line":""},{"line_number":168,"context_line":"To meet these needs developers must employ the use of documentation and release notes"},{"line_number":169,"context_line":"which should be submitted along with any code submissions. All forms of documentation"},{"line_number":170,"context_line":"should comply with the guidelines provided in the `OpenStack Documentation Contributor"},{"line_number":171,"context_line":"Guide`_, with particular reference to the following sections:"},{"line_number":172,"context_line":""},{"line_number":173,"context_line":"* Writing style"},{"line_number":174,"context_line":"* RST formatting conventions"}],"source_content_type":"text/x-rst","patch_set":1,"id":"dab17558_2b7c871f","line":171,"range":{"start_line":170,"start_character":50,"end_line":171,"end_character":7},"in_reply_to":"dab17558_97f95fcb","updated":"2016-05-13 14:15:46.000000000","message":"+1 - found it!","commit_id":"c5816968f0de3f0109724e3e4c76d850500f2afd"},{"author":{"_account_id":6816,"name":"Jesse Pretorius","email":"jesse@odyssey4.me","username":"jesse-pretorius"},"change_message_id":"a86c7874123ea508337d49a8154050c223bcdf37","unresolved":false,"context_lines":[{"line_number":173,"context_line":"* Writing style"},{"line_number":174,"context_line":"* RST formatting conventions"},{"line_number":175,"context_line":""},{"line_number":176,"context_line":"Release notes are generated using `the reno tool`_. Release notes must be written with"},{"line_number":177,"context_line":"the following guidelines in mind:"},{"line_number":178,"context_line":""},{"line_number":179,"context_line":"* Each list item must make sense to read without the context of the patch or"}],"source_content_type":"text/x-rst","patch_set":1,"id":"dab17558_80e7523f","line":176,"range":{"start_line":176,"start_character":0,"end_line":176,"end_character":13},"updated":"2016-05-13 13:58:20.000000000","message":"Should I leave the above as an intro and then do specific sections for Release Notes, Code Comments, Install/Upgrade Guide Documentation and Role Documentation?","commit_id":"c5816968f0de3f0109724e3e4c76d850500f2afd"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"a76da07745bcaeba363bf8a6101a9c22cfd7947c","unresolved":false,"context_lines":[{"line_number":173,"context_line":"* Writing style"},{"line_number":174,"context_line":"* RST formatting conventions"},{"line_number":175,"context_line":""},{"line_number":176,"context_line":"Release notes are generated using `the reno tool`_. Release notes must be written with"},{"line_number":177,"context_line":"the following guidelines in mind:"},{"line_number":178,"context_line":""},{"line_number":179,"context_line":"* Each list item must make sense to read without the context of the patch or"}],"source_content_type":"text/x-rst","patch_set":1,"id":"dab17558_ab8eb724","line":176,"range":{"start_line":176,"start_character":0,"end_line":176,"end_character":13},"in_reply_to":"dab17558_80e7523f","updated":"2016-05-13 14:15:46.000000000","message":"Yes, I think that would increase the readability :)","commit_id":"c5816968f0de3f0109724e3e4c76d850500f2afd"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"8f9e23bf471619f13c1f5bacf20844177198b7e2","unresolved":false,"context_lines":[{"line_number":197,"context_line":"  fixes the issue. Issue notes should specifically make mention of what"},{"line_number":198,"context_line":"  versions of OpenStack-Ansible are affected by the issue."},{"line_number":199,"context_line":"* ``upgrade``: This should inform the deployer about changes which may affect"},{"line_number":200,"context_line":"  them when upgrading from a previous major or minor version. Typically these"},{"line_number":201,"context_line":"  notes would describe changes to default variable values or variables that"},{"line_number":202,"context_line":"  have been removed."},{"line_number":203,"context_line":"* ``deprecations``: If a variable has been deprecated (ideally using the"}],"source_content_type":"text/x-rst","patch_set":1,"id":"dab17558_97dddf72","line":200,"updated":"2016-05-13 12:39:55.000000000","message":"Typically, *","commit_id":"c5816968f0de3f0109724e3e4c76d850500f2afd"},{"author":{"_account_id":6816,"name":"Jesse Pretorius","email":"jesse@odyssey4.me","username":"jesse-pretorius"},"change_message_id":"cce4731848e59f22ff210d47e918b62b7b3233c3","unresolved":false,"context_lines":[{"line_number":197,"context_line":"  fixes the issue. Issue notes should specifically make mention of what"},{"line_number":198,"context_line":"  versions of OpenStack-Ansible are affected by the issue."},{"line_number":199,"context_line":"* ``upgrade``: This should inform the deployer about changes which may affect"},{"line_number":200,"context_line":"  them when upgrading from a previous major or minor version. Typically these"},{"line_number":201,"context_line":"  notes would describe changes to default variable values or variables that"},{"line_number":202,"context_line":"  have been removed."},{"line_number":203,"context_line":"* ``deprecations``: If a variable has been deprecated (ideally using the"}],"source_content_type":"text/x-rst","patch_set":1,"id":"dab17558_97a31f9e","line":200,"in_reply_to":"dab17558_97dddf72","updated":"2016-05-13 12:43:39.000000000","message":"Sure.","commit_id":"c5816968f0de3f0109724e3e4c76d850500f2afd"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"8f9e23bf471619f13c1f5bacf20844177198b7e2","unresolved":false,"context_lines":[{"line_number":201,"context_line":"  notes would describe changes to default variable values or variables that"},{"line_number":202,"context_line":"  have been removed."},{"line_number":203,"context_line":"* ``deprecations``: If a variable has been deprecated (ideally using the"},{"line_number":204,"context_line":"  deprecation filter) then it should be communicated through notes in this"},{"line_number":205,"context_line":"  section. Note that if a variable has been removed entirely then it has not"},{"line_number":206,"context_line":"  been deprecated and the removal should be noted in the ``upgrade`` section."},{"line_number":207,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"dab17558_97c4bf92","line":204,"updated":"2016-05-13 12:39:55.000000000","message":"comma after: depreciation filter),*","commit_id":"c5816968f0de3f0109724e3e4c76d850500f2afd"},{"author":{"_account_id":6816,"name":"Jesse Pretorius","email":"jesse@odyssey4.me","username":"jesse-pretorius"},"change_message_id":"9ef691a571b60b472b3b94673bfe9e7aca8a3279","unresolved":false,"context_lines":[{"line_number":201,"context_line":"  notes would describe changes to default variable values or variables that"},{"line_number":202,"context_line":"  have been removed."},{"line_number":203,"context_line":"* ``deprecations``: If a variable has been deprecated (ideally using the"},{"line_number":204,"context_line":"  deprecation filter) then it should be communicated through notes in this"},{"line_number":205,"context_line":"  section. Note that if a variable has been removed entirely then it has not"},{"line_number":206,"context_line":"  been deprecated and the removal should be noted in the ``upgrade`` section."},{"line_number":207,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"dab17558_17e28e01","line":204,"in_reply_to":"dab17558_570c1794","updated":"2016-05-13 12:57:55.000000000","message":"Ah yes, I now vaguely recall something like that. Bah, I\u0027ll put in a comma as I think it more clearly focuses the point in this structure.","commit_id":"c5816968f0de3f0109724e3e4c76d850500f2afd"},{"author":{"_account_id":10607,"name":"Alexandra Settle","email":"a.settle@outlook.com","username":"asettle"},"change_message_id":"10b5f42669319e8e1f233e9f33025338be7b395a","unresolved":false,"context_lines":[{"line_number":201,"context_line":"  notes would describe changes to default variable values or variables that"},{"line_number":202,"context_line":"  have been removed."},{"line_number":203,"context_line":"* ``deprecations``: If a variable has been deprecated (ideally using the"},{"line_number":204,"context_line":"  deprecation filter) then it should be communicated through notes in this"},{"line_number":205,"context_line":"  section. Note that if a variable has been removed entirely then it has not"},{"line_number":206,"context_line":"  been deprecated and the removal should be noted in the ``upgrade`` section."},{"line_number":207,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"dab17558_570c1794","line":204,"in_reply_to":"dab17558_57825701","updated":"2016-05-13 12:47:02.000000000","message":"The word \u0027then\u0027 implies a separate run on sentence. So, for your desired effect: \"Communicate through notes in this section if a variable has been deprecated.\"","commit_id":"c5816968f0de3f0109724e3e4c76d850500f2afd"},{"author":{"_account_id":6816,"name":"Jesse Pretorius","email":"jesse@odyssey4.me","username":"jesse-pretorius"},"change_message_id":"cce4731848e59f22ff210d47e918b62b7b3233c3","unresolved":false,"context_lines":[{"line_number":201,"context_line":"  notes would describe changes to default variable values or variables that"},{"line_number":202,"context_line":"  have been removed."},{"line_number":203,"context_line":"* ``deprecations``: If a variable has been deprecated (ideally using the"},{"line_number":204,"context_line":"  deprecation filter) then it should be communicated through notes in this"},{"line_number":205,"context_line":"  section. Note that if a variable has been removed entirely then it has not"},{"line_number":206,"context_line":"  been deprecated and the removal should be noted in the ``upgrade`` section."},{"line_number":207,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"dab17558_57825701","line":204,"in_reply_to":"dab17558_97c4bf92","updated":"2016-05-13 12:43:39.000000000","message":"As I recall () is used in a similar way to commas so it seems odd to me to have both. Also I\u0027m under the impression that the sentence should read without the content between the () - adding a comma there breaks the flow of the sentence. What am I missing?","commit_id":"c5816968f0de3f0109724e3e4c76d850500f2afd"},{"author":{"_account_id":19814,"name":"Travis Truman (automagically)","email":"travis_truman@cable.comcast.com","username":"trumant"},"change_message_id":"0c7c3f68f9b3418b5c76289b968274ccad39765e","unresolved":false,"context_lines":[{"line_number":160,"context_line":"Documentation is a critical part of ensuring that the deployers of OpenStack-Ansible"},{"line_number":161,"context_line":"are appropriately informed about:"},{"line_number":162,"context_line":""},{"line_number":163,"context_line":"* How to use the project\u0027s tooling effectively to deploy OpenStack;"},{"line_number":164,"context_line":"* How to implement the right configuration to meet the needs of their specific"},{"line_number":165,"context_line":"  use-case;"},{"line_number":166,"context_line":"* To understand the changes in the project over time which may affect an existing"}],"source_content_type":"text/x-rst","patch_set":2,"id":"dab17558_361b4b1e","line":163,"range":{"start_line":163,"start_character":66,"end_line":163,"end_character":67},"updated":"2016-05-13 15:57:40.000000000","message":"Not sure these are needed or desirable","commit_id":"dd0c31f5e5a0abc34c01beec90ec6202a60b2f9c"},{"author":{"_account_id":19814,"name":"Travis Truman (automagically)","email":"travis_truman@cable.comcast.com","username":"trumant"},"change_message_id":"0c7c3f68f9b3418b5c76289b968274ccad39765e","unresolved":false,"context_lines":[{"line_number":163,"context_line":"* How to use the project\u0027s tooling effectively to deploy OpenStack;"},{"line_number":164,"context_line":"* How to implement the right configuration to meet the needs of their specific"},{"line_number":165,"context_line":"  use-case;"},{"line_number":166,"context_line":"* To understand the changes in the project over time which may affect an existing"},{"line_number":167,"context_line":"  deployment."},{"line_number":168,"context_line":""},{"line_number":169,"context_line":"To meet these needs developers must submit code comments, documentation and"}],"source_content_type":"text/x-rst","patch_set":2,"id":"dab17558_56cecf83","line":166,"range":{"start_line":166,"start_character":2,"end_line":166,"end_character":20},"updated":"2016-05-13 15:57:40.000000000","message":"Superfluous, I\u0027d suggest just starting with \"Changes in the project...\"","commit_id":"dd0c31f5e5a0abc34c01beec90ec6202a60b2f9c"},{"author":{"_account_id":19814,"name":"Travis Truman (automagically)","email":"travis_truman@cable.comcast.com","username":"trumant"},"change_message_id":"0c7c3f68f9b3418b5c76289b968274ccad39765e","unresolved":false,"context_lines":[{"line_number":167,"context_line":"  deployment."},{"line_number":168,"context_line":""},{"line_number":169,"context_line":"To meet these needs developers must submit code comments, documentation and"},{"line_number":170,"context_line":"release notes whith any code submissions. All forms of documentation should"},{"line_number":171,"context_line":"comply with the guidelines provided in the `OpenStack Documentation Contributor"},{"line_number":172,"context_line":"Guide`_, with particular reference to the following sections:"},{"line_number":173,"context_line":""}],"source_content_type":"text/x-rst","patch_set":2,"id":"dab17558_16828700","line":170,"range":{"start_line":170,"start_character":14,"end_line":170,"end_character":19},"updated":"2016-05-13 15:57:40.000000000","message":"spelling","commit_id":"dd0c31f5e5a0abc34c01beec90ec6202a60b2f9c"},{"author":{"_account_id":19814,"name":"Travis Truman (automagically)","email":"travis_truman@cable.comcast.com","username":"trumant"},"change_message_id":"0c7c3f68f9b3418b5c76289b968274ccad39765e","unresolved":false,"context_lines":[{"line_number":201,"context_line":"   statements of intent. The work to fulfill the intent is ongoing. Any new"},{"line_number":202,"context_line":"   documentation submissions should try to help this intent where possible."},{"line_number":203,"context_line":""},{"line_number":204,"context_line":"The `install guide \u003c../install-guide/`_ is primarily intends to help deployers"},{"line_number":205,"context_line":"install OpenStack-Ansible for the first time. As such any documentation"},{"line_number":206,"context_line":"included in the install guide is somewhat opinionated, focusing on trying to"},{"line_number":207,"context_line":"ensure that the deployer has to make very few decisions and implement the least"}],"source_content_type":"text/x-rst","patch_set":2,"id":"dab17558_d6c63f15","line":204,"range":{"start_line":204,"start_character":40,"end_line":204,"end_character":53},"updated":"2016-05-13 15:57:40.000000000","message":"superfluous","commit_id":"dd0c31f5e5a0abc34c01beec90ec6202a60b2f9c"},{"author":{"_account_id":19814,"name":"Travis Truman (automagically)","email":"travis_truman@cable.comcast.com","username":"trumant"},"change_message_id":"0c7c3f68f9b3418b5c76289b968274ccad39765e","unresolved":false,"context_lines":[{"line_number":202,"context_line":"   documentation submissions should try to help this intent where possible."},{"line_number":203,"context_line":""},{"line_number":204,"context_line":"The `install guide \u003c../install-guide/`_ is primarily intends to help deployers"},{"line_number":205,"context_line":"install OpenStack-Ansible for the first time. As such any documentation"},{"line_number":206,"context_line":"included in the install guide is somewhat opinionated, focusing on trying to"},{"line_number":207,"context_line":"ensure that the deployer has to make very few decisions and implement the least"},{"line_number":208,"context_line":"amount of configuration possible to get to the point of a running OpenStack"},{"line_number":209,"context_line":"environment."}],"source_content_type":"text/x-rst","patch_set":2,"id":"dab17558_76e03397","line":206,"range":{"start_line":205,"start_character":53,"end_line":206,"end_character":12},"updated":"2016-05-13 15:57:40.000000000","message":",","commit_id":"dd0c31f5e5a0abc34c01beec90ec6202a60b2f9c"},{"author":{"_account_id":19814,"name":"Travis Truman (automagically)","email":"travis_truman@cable.comcast.com","username":"trumant"},"change_message_id":"0c7c3f68f9b3418b5c76289b968274ccad39765e","unresolved":false,"context_lines":[{"line_number":203,"context_line":""},{"line_number":204,"context_line":"The `install guide \u003c../install-guide/`_ is primarily intends to help deployers"},{"line_number":205,"context_line":"install OpenStack-Ansible for the first time. As such any documentation"},{"line_number":206,"context_line":"included in the install guide is somewhat opinionated, focusing on trying to"},{"line_number":207,"context_line":"ensure that the deployer has to make very few decisions and implement the least"},{"line_number":208,"context_line":"amount of configuration possible to get to the point of a running OpenStack"},{"line_number":209,"context_line":"environment."}],"source_content_type":"text/x-rst","patch_set":2,"id":"dab17558_76edd3b6","line":206,"range":{"start_line":206,"start_character":67,"end_line":206,"end_character":76},"updated":"2016-05-13 15:57:40.000000000","message":"superfluous, \"ensuring\"","commit_id":"dd0c31f5e5a0abc34c01beec90ec6202a60b2f9c"},{"author":{"_account_id":19814,"name":"Travis Truman (automagically)","email":"travis_truman@cable.comcast.com","username":"trumant"},"change_message_id":"0c7c3f68f9b3418b5c76289b968274ccad39765e","unresolved":false,"context_lines":[{"line_number":205,"context_line":"install OpenStack-Ansible for the first time. As such any documentation"},{"line_number":206,"context_line":"included in the install guide is somewhat opinionated, focusing on trying to"},{"line_number":207,"context_line":"ensure that the deployer has to make very few decisions and implement the least"},{"line_number":208,"context_line":"amount of configuration possible to get to the point of a running OpenStack"},{"line_number":209,"context_line":"environment."},{"line_number":210,"context_line":""},{"line_number":211,"context_line":"The role documentation (for example, the `keystone role documentation`_) is"}],"source_content_type":"text/x-rst","patch_set":2,"id":"dab17558_b67bbbf3","line":208,"range":{"start_line":208,"start_character":36,"end_line":208,"end_character":55},"updated":"2016-05-13 15:57:40.000000000","message":"\"deploy\"","commit_id":"dd0c31f5e5a0abc34c01beec90ec6202a60b2f9c"},{"author":{"_account_id":19814,"name":"Travis Truman (automagically)","email":"travis_truman@cable.comcast.com","username":"trumant"},"change_message_id":"0c7c3f68f9b3418b5c76289b968274ccad39765e","unresolved":false,"context_lines":[{"line_number":208,"context_line":"amount of configuration possible to get to the point of a running OpenStack"},{"line_number":209,"context_line":"environment."},{"line_number":210,"context_line":""},{"line_number":211,"context_line":"The role documentation (for example, the `keystone role documentation`_) is"},{"line_number":212,"context_line":"intended to explain all the options available for the role and how to implement"},{"line_number":213,"context_line":"more advanced requirements. To try and reduce duplication, the role"},{"line_number":214,"context_line":"documentation uses includes for the role defaults which have comments to"},{"line_number":215,"context_line":"explain the variables. The long hand documentation for the roles should"}],"source_content_type":"text/x-rst","patch_set":2,"id":"dab17558_d6947fe9","line":212,"range":{"start_line":211,"start_character":72,"end_line":212,"end_character":8},"updated":"2016-05-13 15:57:40.000000000","message":"\"intends\"","commit_id":"dd0c31f5e5a0abc34c01beec90ec6202a60b2f9c"},{"author":{"_account_id":19814,"name":"Travis Truman (automagically)","email":"travis_truman@cable.comcast.com","username":"trumant"},"change_message_id":"0c7c3f68f9b3418b5c76289b968274ccad39765e","unresolved":false,"context_lines":[{"line_number":219,"context_line":"Where possible the documentation in OpenStack-Ansible should steer clear of"},{"line_number":220,"context_line":"trying to explain OpenStack concepts. Those explanations belong in the"},{"line_number":221,"context_line":"OpenStack Manuals or service documentation and OpenStack-Ansible documentation"},{"line_number":222,"context_line":"should link to where those are located instead of duplicating the content."},{"line_number":223,"context_line":""},{"line_number":224,"context_line":".. _keystone role documentation: http://docs.openstack.org/developer/openstack-ansible-os_keystone/"},{"line_number":225,"context_line":""}],"source_content_type":"text/x-rst","patch_set":2,"id":"dab17558_f6b8a377","line":222,"range":{"start_line":222,"start_character":15,"end_line":222,"end_character":73},"updated":"2016-05-13 15:57:40.000000000","message":"those documents when available, rather than duplicate their content.","commit_id":"dd0c31f5e5a0abc34c01beec90ec6202a60b2f9c"},{"author":{"_account_id":14805,"name":"Jimmy McCrory","email":"jimmy.mccrory@gmail.com","username":"jimmy-mccrory"},"change_message_id":"3a7c02e0d6d224c933a40c6b28f3018d3b1c4fc9","unresolved":false,"context_lines":[{"line_number":181,"context_line":"Code comments for variables should be used to explain the purpose of the"},{"line_number":182,"context_line":"variable. This is particularly important for the role defaults file as the file"},{"line_number":183,"context_line":"is included verbatim in the role\u0027s documentation. Where there is a variable that"},{"line_number":184,"context_line":"can be optionally set the variable and an explanation of what it is used for"},{"line_number":185,"context_line":"should be added to the defaults file."},{"line_number":186,"context_line":""},{"line_number":187,"context_line":"Code comments for bash/python scripts should give guidance to the purpose of"}],"source_content_type":"text/x-rst","patch_set":3,"id":"dab17558_6a15e0e3","line":184,"range":{"start_line":184,"start_character":21,"end_line":184,"end_character":22},"updated":"2016-05-13 17:12:27.000000000","message":"comma","commit_id":"7e6862745df826bb6a5f5ebcd6f30ef414d5e2ab"},{"author":{"_account_id":6816,"name":"Jesse Pretorius","email":"jesse@odyssey4.me","username":"jesse-pretorius"},"change_message_id":"7184bb147f622113d720862d6d4554a11f2e4728","unresolved":false,"context_lines":[{"line_number":181,"context_line":"Code comments for variables should be used to explain the purpose of the"},{"line_number":182,"context_line":"variable. This is particularly important for the role defaults file as the file"},{"line_number":183,"context_line":"is included verbatim in the role\u0027s documentation. Where there is a variable that"},{"line_number":184,"context_line":"can be optionally set the variable and an explanation of what it is used for"},{"line_number":185,"context_line":"should be added to the defaults file."},{"line_number":186,"context_line":""},{"line_number":187,"context_line":"Code comments for bash/python scripts should give guidance to the purpose of"}],"source_content_type":"text/x-rst","patch_set":3,"id":"dab17558_c55f9f73","line":184,"range":{"start_line":184,"start_character":21,"end_line":184,"end_character":22},"in_reply_to":"dab17558_6a15e0e3","updated":"2016-05-13 17:35:05.000000000","message":"Done","commit_id":"7e6862745df826bb6a5f5ebcd6f30ef414d5e2ab"},{"author":{"_account_id":14805,"name":"Jimmy McCrory","email":"jimmy.mccrory@gmail.com","username":"jimmy-mccrory"},"change_message_id":"3a7c02e0d6d224c933a40c6b28f3018d3b1c4fc9","unresolved":false,"context_lines":[{"line_number":208,"context_line":""},{"line_number":209,"context_line":"The role documentation (for example, the `keystone role documentation`_)"},{"line_number":210,"context_line":"intends to explain all the options available for the role and how to implement"},{"line_number":211,"context_line":"more advanced requirements. To try and reduce duplication, the role"},{"line_number":212,"context_line":"documentation uses includes for the role defaults which have comments to"},{"line_number":213,"context_line":"explain the variables. The long hand documentation for the roles should"},{"line_number":214,"context_line":"therefore focus less on explaining variables and more on explaining how to"},{"line_number":215,"context_line":"implement advanced use cases."},{"line_number":216,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"dab17558_aa3988a5","line":213,"range":{"start_line":211,"start_character":28,"end_line":213,"end_character":22},"updated":"2016-05-13 17:12:27.000000000","message":"Took me a few rereads to understand.\nMaybe reword \"To reduce duplication, the role documentation directly includes the role\u0027s default variables and comments explaining them.\"","commit_id":"7e6862745df826bb6a5f5ebcd6f30ef414d5e2ab"},{"author":{"_account_id":6816,"name":"Jesse Pretorius","email":"jesse@odyssey4.me","username":"jesse-pretorius"},"change_message_id":"7184bb147f622113d720862d6d4554a11f2e4728","unresolved":false,"context_lines":[{"line_number":208,"context_line":""},{"line_number":209,"context_line":"The role documentation (for example, the `keystone role documentation`_)"},{"line_number":210,"context_line":"intends to explain all the options available for the role and how to implement"},{"line_number":211,"context_line":"more advanced requirements. To try and reduce duplication, the role"},{"line_number":212,"context_line":"documentation uses includes for the role defaults which have comments to"},{"line_number":213,"context_line":"explain the variables. The long hand documentation for the roles should"},{"line_number":214,"context_line":"therefore focus less on explaining variables and more on explaining how to"},{"line_number":215,"context_line":"implement advanced use cases."},{"line_number":216,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"dab17558_85775701","line":213,"range":{"start_line":211,"start_character":28,"end_line":213,"end_character":22},"in_reply_to":"dab17558_aa3988a5","updated":"2016-05-13 17:35:05.000000000","message":"Done","commit_id":"7e6862745df826bb6a5f5ebcd6f30ef414d5e2ab"}]}