Reorganize documentation
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
OpenStack SDK |
Fix Released
|
Undecided
|
Brian Curtin |
Bug Description
The current layout is going to mean a huge amount of stuff goes on the index page of the docs. Too much stuff, in fact.
I think that the docs should be arranged primarily under two headings: for users, and for contributors, in that order
User docs would include the following:
* Change log
* Installation details
* User guides
* API docs - both high level and resource, with high level coming first in any mention
* How to report bugs - where to do it, how to write the report
Contributor docs would include the following:
* How to...build your own auth plugin, create resources for a service, implement a service proxy, modify user preferences, etc
* How to set up a dev environment, run tests, build the docs, run coverage, debugging info, etc.
* Contact information for mailing lists, IRC, etc.
A lot of this is already there or otherwise in progress, but since there's a lot to move it'll take a few changes. This bug is to track those efforts.
Changed in python-openstacksdk: | |
status: | In Progress → Fix Released |
Fix proposed to branch: master /review. openstack. org/151785
Review: https:/