)]}'
{"specs/kilo/doc-updates.rst":[{"author":{"_account_id":6287,"name":"David Lenwell","email":"dlenwell@gmail.com","username":"dlenwell"},"change_message_id":"339af39acf44358cf5ca5039c105d541a32b7bb8","unresolved":false,"context_lines":[{"line_number":29,"context_line":"for merging with the OpenStack documentation."},{"line_number":30,"context_line":""},{"line_number":31,"context_line":"What Is Akanda section will hold the existing High Level Architecture,"},{"line_number":32,"context_line":"Service VM Orchestration and Management, The Service VM sections. We will"},{"line_number":33,"context_line":"add user documentation for demonstrating akanda, understanding how it"},{"line_number":34,"context_line":"orchestrates network services, and how to compare (or not to) akanda to other"},{"line_number":35,"context_line":"SDN options. Add some details around EW and NS frame/packet flow between"}],"source_content_type":"text/x-rst","patch_set":1,"id":"fa32b979_1b507ed3","line":32,"updated":"2015-06-23 22:35:07.000000000","message":"Change VM to \"instance\" so that it will remain accurate if we are orchestrating hardware or containers","commit_id":"679336ae83d37c3ee33d2389d7585443befb6e28"},{"author":{"_account_id":6287,"name":"David Lenwell","email":"dlenwell@gmail.com","username":"dlenwell"},"change_message_id":"339af39acf44358cf5ca5039c105d541a32b7bb8","unresolved":false,"context_lines":[{"line_number":130,"context_line":""},{"line_number":131,"context_line":"Assignee(s)"},{"line_number":132,"context_line":"-----------"},{"line_number":133,"context_line":""},{"line_number":134,"context_line":""},{"line_number":135,"context_line":"Work Items"},{"line_number":136,"context_line":"----------"}],"source_content_type":"text/x-rst","patch_set":1,"id":"fa32b979_5bc36689","line":133,"updated":"2015-06-23 22:35:07.000000000","message":"assuming sean that you are the assignee? you should call yourself out ;)","commit_id":"679336ae83d37c3ee33d2389d7585443befb6e28"},{"author":{"_account_id":1420,"name":"Adam Gandelman","email":"adamg@ubuntu.com","username":"gandelman-a"},"change_message_id":"3b31f0078582f6ba0f6e0d0d2eefdd2e04623504","unresolved":false,"context_lines":[{"line_number":53,"context_line":"Akanda Developer Guide will hold the details on setting up the developer"},{"line_number":54,"context_line":"environment, testing code locally, explaining the CI tests, along with some"},{"line_number":55,"context_line":"references to Neutron dependencies. Add using remotely hosted instances like"},{"line_number":56,"context_line":"DreamHost and Rackspace for development. This entire section will move to the"},{"line_number":57,"context_line":"Akanda developer reference section here [3], once the Akanda project is"},{"line_number":58,"context_line":"accepted into the OpenStack org repo."},{"line_number":59,"context_line":""}],"source_content_type":"text/x-rst","patch_set":2,"id":"ba3cc151_51141043","line":56,"updated":"2015-06-29 23:35:01.000000000","message":"I think documenting how to use cloud provider $foo is beyond the scope here. Noting that documentation/walkthroughs are assumed to be followed on, ie, a fresh ubuntu VM should be enough.","commit_id":"2e4ce721fa729dd6d8909aff12f6de4491661594"},{"author":{"_account_id":6923,"name":"Sean Roberts","email":"seanroberts66@gmail.com","username":"seanrob"},"change_message_id":"0379d26ba23d29fd06c7aeffd2e6e610f3d7bf86","unresolved":false,"context_lines":[{"line_number":53,"context_line":"Akanda Developer Guide will hold the details on setting up the developer"},{"line_number":54,"context_line":"environment, testing code locally, explaining the CI tests, along with some"},{"line_number":55,"context_line":"references to Neutron dependencies. Add using remotely hosted instances like"},{"line_number":56,"context_line":"DreamHost and Rackspace for development. This entire section will move to the"},{"line_number":57,"context_line":"Akanda developer reference section here [3], once the Akanda project is"},{"line_number":58,"context_line":"accepted into the OpenStack org repo."},{"line_number":59,"context_line":""}],"source_content_type":"text/x-rst","patch_set":2,"id":"ba3cc151_aeeb4e12","line":56,"in_reply_to":"ba3cc151_51141043","updated":"2015-07-01 20:10:51.000000000","message":"agreed","commit_id":"2e4ce721fa729dd6d8909aff12f6de4491661594"},{"author":{"_account_id":1420,"name":"Adam Gandelman","email":"adamg@ubuntu.com","username":"gandelman-a"},"change_message_id":"3b31f0078582f6ba0f6e0d0d2eefdd2e04623504","unresolved":false,"context_lines":[{"line_number":58,"context_line":"accepted into the OpenStack org repo."},{"line_number":59,"context_line":""},{"line_number":60,"context_line":"This spec also includes the use of docstrings in the code. We will start with"},{"line_number":61,"context_line":"updating the rug code with docstrings as the most critical."},{"line_number":62,"context_line":""},{"line_number":63,"context_line":""},{"line_number":64,"context_line":"Data Model Impact"}],"source_content_type":"text/x-rst","patch_set":2,"id":"ba3cc151_ce188187","line":61,"updated":"2015-06-29 23:35:01.000000000","message":"I\u0027m curious why you\u0027re so bent on getting filling out missing docstrings on a code that is not intended to be consumed externally? I\u0027d agree this would be critical if we were publishing a python-akandaclient or something, but the RUG\u0027s code is internal stuff and there is no API contract that needs documentation ATM. IMO the big data structures and code-flows in its tree are sufficiently documented in-line, are there specific areas that you\u0027ve hit  that need to be documented?\n\nAlso, going in and writing in-line documentation of code that you didn\u0027t right is tedious and prone to be incorrect. IMO incorrect doc strings are worse than no doc strings.","commit_id":"2e4ce721fa729dd6d8909aff12f6de4491661594"},{"author":{"_account_id":1420,"name":"Adam Gandelman","email":"adamg@ubuntu.com","username":"gandelman-a"},"change_message_id":"2ec2fc8a80209c425d015751549a32271add2361","unresolved":false,"context_lines":[{"line_number":58,"context_line":"accepted into the OpenStack org repo."},{"line_number":59,"context_line":""},{"line_number":60,"context_line":"This spec also includes the use of docstrings in the code. We will start with"},{"line_number":61,"context_line":"updating the rug code with docstrings as the most critical."},{"line_number":62,"context_line":""},{"line_number":63,"context_line":""},{"line_number":64,"context_line":"Data Model Impact"}],"source_content_type":"text/x-rst","patch_set":2,"id":"ba3cc151_efde3110","line":61,"in_reply_to":"ba3cc151_631e260e","updated":"2015-07-01 21:04:01.000000000","message":"I think we just need to get in the habit of improving this incrementally as we go.  It should be best practice document new stuff adequately, and to touch up missing doc strings for things that are not immediately obvious when working on some existing part of the code. There\u0027s enough refactoring going on atm that this would probably fill in whatever is missing relatively soon.\n\nIe: https://review.openstack.org/#/c/194841/5/akanda/rug/api/nova.py  When I was fixing a bug in akanda.rug.api.nova, it took me more than a minute to figure out what a couple of functions should be doing, so i went ahead and documented them with the fix. That should be best practice, anyway.\n\nAlso, pointing new developers who dont fully grok code at a bug tracker seems wasteful.  IRC should be the preferred medium to fix that and bikeshed about implementation.","commit_id":"2e4ce721fa729dd6d8909aff12f6de4491661594"},{"author":{"_account_id":6923,"name":"Sean Roberts","email":"seanroberts66@gmail.com","username":"seanrob"},"change_message_id":"0379d26ba23d29fd06c7aeffd2e6e610f3d7bf86","unresolved":false,"context_lines":[{"line_number":58,"context_line":"accepted into the OpenStack org repo."},{"line_number":59,"context_line":""},{"line_number":60,"context_line":"This spec also includes the use of docstrings in the code. We will start with"},{"line_number":61,"context_line":"updating the rug code with docstrings as the most critical."},{"line_number":62,"context_line":""},{"line_number":63,"context_line":""},{"line_number":64,"context_line":"Data Model Impact"}],"source_content_type":"text/x-rst","patch_set":2,"id":"ba3cc151_631e260e","line":61,"in_reply_to":"ba3cc151_ce188187","updated":"2015-07-01 20:10:51.000000000","message":"I\u0027m open to other ways of getting to know the code. I think this is one of those ways. As you come across something you can\u0027t quite figure out and/or don\u0027t agree with the implementation of, we can file bugs against those. Getting Mark and Doug to review the changes would be best practice as well.","commit_id":"2e4ce721fa729dd6d8909aff12f6de4491661594"},{"author":{"_account_id":16341,"name":"Rama Puranam","email":"rama.puranam@gmail.com","username":"ramap"},"change_message_id":"323777c3fc162f78e664f6e23e442c058e4061bd","unresolved":false,"context_lines":[{"line_number":29,"context_line":"for merging with the OpenStack documentation."},{"line_number":30,"context_line":""},{"line_number":31,"context_line":"What Is Akanda section will hold the existing High Level Architecture,"},{"line_number":32,"context_line":"Service VM Orchestration and Management, The Service VM sections. These pages"},{"line_number":33,"context_line":"VM will be renamed to Instance. We will"},{"line_number":34,"context_line":"add user documentation for demonstrating akanda, understanding how it"},{"line_number":35,"context_line":"orchestrates network services, and how to compare (or not to) akanda to other"}],"source_content_type":"text/x-rst","patch_set":3,"id":"3a50d1a3_e99b7415","line":32,"updated":"2015-07-28 18:28:14.000000000","message":"Pl check sentence formation, bit confusing","commit_id":"7bd94d09134923dd570db9f765695479d2745e93"},{"author":{"_account_id":16341,"name":"Rama Puranam","email":"rama.puranam@gmail.com","username":"ramap"},"change_message_id":"323777c3fc162f78e664f6e23e442c058e4061bd","unresolved":false,"context_lines":[{"line_number":56,"context_line":"references to Neutron dependencies. This entire section will move to the"},{"line_number":57,"context_line":"Akanda developer reference section here [3], once the Akanda project is"},{"line_number":58,"context_line":"accepted into the OpenStack org repo."},{"line_number":59,"context_line":""},{"line_number":60,"context_line":"This spec also includes the use of docstrings in the code. We will start with"},{"line_number":61,"context_line":"updating the rug code with docstrings as the most critical."},{"line_number":62,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"3a50d1a3_ac425a3c","line":59,"updated":"2015-07-28 18:28:14.000000000","message":"The Developer Guide should also have a section for FAQ kind of which could capture common errors and solutions for the same. Developers / Integrators are welcome to contact team Akanda on IRC, but we should make the documentation as useful as possible.","commit_id":"7bd94d09134923dd570db9f765695479d2745e93"}]}