Difference between revisions of "Glance-where-are-the-docs"
m (→"quickstart" guide) |
m |
||
| Line 7: | Line 7: | ||
** http://docs.openstack.org/developer/glance/ | ** http://docs.openstack.org/developer/glance/ | ||
** http://docs.openstack.org/developer/python-glanceclient/ | ** http://docs.openstack.org/developer/python-glanceclient/ | ||
| + | * content: should contain information for contributors to the Glance project itself | ||
== "API docs" written by Top Professionals == | == "API docs" written by Top Professionals == | ||
* generated from files in https://github.com/openstack/image-api | * generated from files in https://github.com/openstack/image-api | ||
| Line 13: | Line 14: | ||
* v2 generated from markdown files in openstack-image-service-api/src/markdown | * 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/ | ** posted at: http://docs.openstack.org/api/openstack-image-service/2.0/content/ | ||
| + | * content: the API specifications | ||
== "operator docs" == | == "operator docs" == | ||
* generated from XML files in https://github.com/openstack/openstack-manuals | * generated from XML files in https://github.com/openstack/openstack-manuals | ||
| Line 21: | Line 23: | ||
** (may be some other stuff, and files are occasionally split/reorganized) | ** (may be some other stuff, and files are occasionally split/reorganized) | ||
* posted at: http://docs.openstack.org/grizzly/openstack-compute/admin/content/ | * posted at: http://docs.openstack.org/grizzly/openstack-compute/admin/content/ | ||
| + | * content: installation and administration information | ||
== "quickstart" guide == | == "quickstart" guide == | ||
(Note: this may have been split out into the "api-site" docs, need to check) | (Note: this may have been split out into the "api-site" docs, need to check) | ||
| Line 27: | Line 30: | ||
** doc/src/docbkx/cli-guide/src/glance_cli_howto.xml | ** doc/src/docbkx/cli-guide/src/glance_cli_howto.xml | ||
* posted at: http://docs.openstack.org/cli/quick-start/content/ | * posted at: http://docs.openstack.org/cli/quick-start/content/ | ||
| + | |||
| + | <div style="margin-top:10ex"> | ||
| + | For other projects, see https://wiki.openstack.org/wiki/Documentation/Builds#Source_and_target_locations_of_documentation_.28current.29 | ||
| + | </div> | ||
Revision as of 18:46, 1 August 2013
This info is accurate as of 27 June 2013. Info about contributing to the documentation is here: https://wiki.openstack.org/wiki/Documentation
Contents
"dev docs" written 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
"API docs" written by Top Professionals
- 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
"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
"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/
