Improve Python Client Guide Quality - for app developers
The python-*client packages are the closest thing OpenStack has to python language bindings/python SDK. They provide much functionality, but using them to achieve the goals of an application developer working with python, building an application on top of an OpenStack cloud, is currently thwarted by poor documentation. This blueprint is aimed at improving the quality of this documentation to the point where app developers can happily use it in their day-to-day interactions with OpenStack Clouds.
Blueprint information
- Status:
- Complete
- Approver:
- Tom Fifield
- Priority:
- Essential
- Drafter:
- Tom Fifield
- Direction:
- Approved
- Assignee:
- Lorin Hochstein
- Definition:
- Approved
- Series goal:
- Accepted for juno
- Implementation:
-
Implemented
- Milestone target:
-
juno
- Started by
- Tom Fifield
- Completed by
- Tom Fifield
Related branches
Related bugs
Sprints
Whiteboard
Tom, I think we added the Python SDK chapter to the User Guide in hopes of alleviating some of this difficulty. http://
To maintain docs across python-*client is not sustainable, and the bigger picture is to document the common openstack client and common SDKs. Let's discuss further before approving this blueprint. To me, the work items are not improving the existing sites but finding commonality and improvements for developer.
Existing sites:
- http://
- http://
- http://
- http://
- http://
- http://
- http://
- http://
Work Items
Work items:
Come up with consistent structure: TODO
Implement that across each project: TODO
Worked example for each Python binding call: TODO
