Difference between revisions of "Glance-where-are-the-docs"
m (→"operator docs") |
(updated to include refs to new guides published for havana) |
||
| Line 33: | Line 33: | ||
== "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 | ||
| − | * for glance: | + | * file bugs at: https://bugs.launchpad.net/openstack-manuals |
| − | ** | + | * ''OpenStack Compute Administration Guide'' |
| − | ** | + | ** content: installation and administration information |
| − | ** | + | ** source files for glance-specific stuff: |
| + | *** doc/common/section_glance_cli_manage_images.xml | ||
| + | *** doc/common/section_glance_image-formats.xml | ||
| + | ** source files for glance related stuff (some suggested values for image properties): | ||
| + | *** doc/admin-guide-cloud/section_adding-images.xml | ||
** (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/ | + | ** posted at: http://docs.openstack.org/trunk/openstack-compute/admin/content/ |
| − | * content: | + | * ''OpenStack Virtual Machine Image Guide'' (not glance-specific) |
| − | * | + | ** content: how to obtain, create, and modify virtual machine images that are compatible with OpenStack |
| + | ** source: https://github.com/openstack/openstack-manuals/tree/master/doc/image-guide | ||
| + | ** posted at: http://docs.openstack.org/trunk/openstack-image/content/ | ||
| + | |||
== End User Guide (formerly, the "quickstart" guide) == | == End User Guide (formerly, the "quickstart" guide) == | ||
* generated from XML files in https://github.com/openstack/openstack-manuals | * generated from XML files in https://github.com/openstack/openstack-manuals | ||
| − | ** doc/ | + | ** doc/user-guide/section_glance_cli.xml |
| − | ** doc/ | + | ** doc/user-guide/section_glance_cli_commands.xml |
* posted at: http://docs.openstack.org/user-guide/content/ | * posted at: http://docs.openstack.org/user-guide/content/ | ||
* file bugs at: http://bugs.launchpad.net/openstack-manuals | * file bugs at: http://bugs.launchpad.net/openstack-manuals | ||
Revision as of 12:11, 10 September 2013
This info is accurate as of 1 August 2013.
Info about contributing to the documentation is here: https://wiki.openstack.org/wiki/Documentation (basically, you clone a repo and use gerrit just like you do for code)
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
API Quick Reference Docs
- generated from XML files in: https://github.com/openstack/api-site
- posted at: http://api.openstack.org/api-ref.html
- content: quick ref docs and WADLs for the API
- file bugs at: http://bugs.launchpad.net/openstack-api-site
"operator docs"
- generated from XML files in https://github.com/openstack/openstack-manuals
- file bugs at: https://bugs.launchpad.net/openstack-manuals
- OpenStack Compute Administration Guide
- content: installation and administration information
- source files for glance-specific stuff:
- doc/common/section_glance_cli_manage_images.xml
- doc/common/section_glance_image-formats.xml
- source files for glance related stuff (some suggested values for image properties):
- doc/admin-guide-cloud/section_adding-images.xml
- (may be some other stuff, and files are occasionally split/reorganized)
- posted at: http://docs.openstack.org/trunk/openstack-compute/admin/content/
- OpenStack Virtual Machine Image Guide (not glance-specific)
- content: how to obtain, create, and modify virtual machine images that are compatible with OpenStack
- source: https://github.com/openstack/openstack-manuals/tree/master/doc/image-guide
- posted at: http://docs.openstack.org/trunk/openstack-image/content/
End User Guide (formerly, the "quickstart" guide)
- generated from XML files in https://github.com/openstack/openstack-manuals
- doc/user-guide/section_glance_cli.xml
- doc/user-guide/section_glance_cli_commands.xml
- posted at: http://docs.openstack.org/user-guide/content/
- file bugs at: http://bugs.launchpad.net/openstack-manuals
For other projects, see https://wiki.openstack.org/wiki/Documentation/Builds#Source_and_target_locations_of_documentation_.28current.29
Also, join #openstack-doc on Freenode for real time answers to questions. The documentation team also has "office hours" Mondays at noon EST.
