Difference between revisions of "Glance-where-are-the-docs"

Revision as of 20:02, 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.

generated from the rst files in the doc/source directory in the source code
posted at:
- http://docs.openstack.org/developer/glance/
- http://docs.openstack.org/developer/python-glanceclient/
content: should contain information for contributors to the Glance project itself
file bugs at:
- https://bugs.launchpad.net/glance
- https://bugs.launchpad.net/python-glanceclient

generated from files in https://github.com/openstack/image-api
v1 generated from XML files in openstack-image-service-api/src/docbkx
- posted at: http://docs.openstack.org/api/openstack-image-service/1.1/content/
v2 generated from markdown files in openstack-image-service-api/src/markdown
- posted at: http://docs.openstack.org/api/openstack-image-service/2.0/content/
content: the API specifications
file bugs at: http://bugs.launchpad.net/openstack-api-site

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

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/user-guide/content/
file bugs at: http://bugs.launchpad.net/openstack-manuals

@@ Line 36: / Line 36: @@
 * file bugs at: https://bugs.launchpad.net/openstack-manuals
 == End User Guide (formerly, the "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