Difference between revisions of "Glance-where-are-the-docs"
Annegentle (talk | contribs) (→"dev docs" written by developers working on glance) |
Annegentle (talk | contribs) (→"API docs" written by Top Professionals) |
||
| Line 16: | Line 16: | ||
** https://bugs.launchpad.net/python-glanceclient | ** https://bugs.launchpad.net/python-glanceclient | ||
| − | == "API docs" written | + | == "API docs" written for application developers and people who upload images programmatically == |
* generated from files in https://github.com/openstack/image-api | * generated from files in https://github.com/openstack/image-api | ||
* v1 generated from XML files in openstack-image-service-api/src/docbkx | * v1 generated from XML files in openstack-image-service-api/src/docbkx | ||
Revision as of 19:55, 1 August 2013
This info is accurate as of 1 August 2013.
Info about contributing to the documentation is here: https://wiki.openstack.org/wiki/Documentation
Note to Glance devs: file a bug when you plan to contribute to/update documentation so there's no duplication of effort.
Contents
"dev docs" written for Python developers by developers working on glance
- generated from the rst files in the doc/source directory in the source code
- posted at:
- content: should contain information for contributors to the Glance project itself
- file bugs at:
"API docs" written for application developers and people who upload images programmatically
- generated from files in https://github.com/openstack/image-api
- v1 generated from XML files in openstack-image-service-api/src/docbkx
- v2 generated from markdown files in openstack-image-service-api/src/markdown
- content: the API specifications
- file bugs at: http://bugs.launchpad.net/openstack-api-site
"operator docs"
- generated from XML files in https://github.com/openstack/openstack-manuals
- for glance:
- doc/src/docbkx/common/adding-images.xml
- doc/src/docbkx/common/ch_image_mgmt.xml
- doc/src/docbkx/common/image-formats.xml
- (may be some other stuff, and files are occasionally split/reorganized)
- posted at: http://docs.openstack.org/grizzly/openstack-compute/admin/content/
- content: installation and administration information
- file bugs at: https://bugs.launchpad.net/openstack-manuals
"quickstart" guide
(Note: this may have been split out into the "api-site" docs, need to check)
- generated from XML files in https://github.com/openstack/openstack-manuals
- doc/src/docbkx/cli-guide/src/glance_cli_commands.xml
- doc/src/docbkx/cli-guide/src/glance_cli_howto.xml
- posted at: http://docs.openstack.org/cli/quick-start/content/
- file bugs at: http://bugs.launchpad.net/openstack-manuals
