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

Revision as of 13:42, 29 April 2016

This info is accurate as of 29 April 2016.

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.

"dev docs" written by the OpenStack developers working on Glance

audience: there are two primary audiences:
1. software developers who want to work on Glance and/or the python-glanceclient
2. Glance users: "Developer docs should be anything you feel is relevant to Glance users that isn't covered in openstack-manuals. Basically, manuals can't cover everything, so this is where you make up the shortfall" (Lara Brindley, current Docs PTL)
generated from the rst files in the doc/source directory in the source code
- https://github.com/openstack/glance
posted at:
- http://docs.openstack.org/developer/glance/
- http://docs.openstack.org/developer/python-glanceclient/
- status: not versioned, should always reflect master
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
generate the docs locally withː
- tox -e docs
- It will create a directory /opt/stack/glance/doc/build which has html and man subdirectories

API Reference Documentation

audience: prospective end users -- the intended audience consists of application developers and SDK developers who need precise and accurate information about the REST APIs implemented by Glance.
status: being reworked in Newton
- source is being migrated from WADL to Swagger to yaml ; docs will be generated by Sphinx ; code to do this should be available at Newton RC-1
posted at http://api.openstack.org/api-ref.html
file bugs at: http://bugs.launchpad.net/openstack-api-site

== API Reference (Narrative style)

currently in the glance-specs repo
currently published with the specs

OpenStack Manuals

audience: consumers of OpenStack in their various roles. The manuals are broken into Installation, Ops & Admin, and User Guides.
file bugs at: https://bugs.launchpad.net/openstack-manuals
source: https://github.com/openstack/openstack-manuals
Find more on documentation team processes hereː http://docs.openstack.org/contributor-guide/
OpenStack Cloud Administrator Guide
- content: installation and administration information
- source files for glance related stuff
  - openstack-manuals/doc/admin-guide/source/compute-images-instances.rst
  - (may be some other stuff, and files are occasionally split/reorganized)
- posted at: http://docs.openstack.org/admin-guide/
"OpenStack Command-Line Interface Reference"
- openstack-manuals/doc/cli-reference/source/glance_property_keys.rst (suggested values for common image properties)
- openstack-manuals/doc/cli-reference/source/glance.rst (automatically generated from python-glanceclient help, so make changes in the glanceclient tree, not here)
- posted at http://docs.openstack.org/cli-reference/
"OpenStack Configuration Reference"
- doc/config-reference/source/image-service
  - these are at least partially generated from the glance config files, so check with doc team about where to make changes
- posted at: http://docs.openstack.org/mitaka/config-reference/
OpenStack Virtual Machine Image Guide (not glance-specific)
- content: how to obtain, create, and modify virtual machine images that are compatible with OpenStack
- source: openstack-manuals/doc/image-guide/source/
- posted at: http://docs.openstack.org/image-guide/

End User Guide

source: openstack-manuals/doc/user-guide/source/
- (not sure what Glance content is in there ATM)
posted at: http://docs.openstack.org/user-guide/
file bugs at: http://bugs.launchpad.net/openstack-manuals

For other projects, see http://docs.openstack.org/contributor-guide/docs-builds.html#documentation-source-and-target-locations
For general documentation project info, see https://wiki.openstack.org/wiki/Documentation
Also, join #openstack-doc on Freenode for real time answers to questions.

@@ Line 1: / Line 1: @@
-This info is accurate as of 5 September 2014.
+This info is accurate as of 29 April 2016.
 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)
@@ Line 27: / Line 27: @@
 == API Reference Documentation ==
 * audience: prospective end users -- the intended audience consists of application developers and SDK developers who need precise and accurate information about the REST APIs implemented by Glance.
-* status: being reworked in Liberty following this spec: https://review.openstack.org/#/c/177934/
+* status: being reworked in Newton
-* generated from files in https://github.com/openstack/api-site
+** source is being migrated from WADL to Swagger to yaml ; docs will be generated by Sphinx ; code to do this should be available at Newton RC-1
 * posted at http://api.openstack.org/api-ref.html
 * file bugs at: http://bugs.launchpad.net/openstack-api-site
-* note: There used to be narrative style API Reference Docs  The source code is still at https://github.com/openstack/image-api, but it's been moved to the attic.  The repo README has this note: "To update Image API information, please submit patches to http://git.openstack.org/cgit/openstack/glance-specs for a new API feature and to http://git.openstack.org/cgit/openstack/api-site for implemented API information."
+== API Reference (Narrative style)
+* currently in the glance-specs repo
+* currently published with the specs
 == OpenStack Manuals ==
 * audience: consumers of OpenStack in their various roles.  The manuals are broken into Installation, Ops & Admin, and User Guides.
-== under construction ==
-(ignore all below here)
-*  generated from XML files in http://git.openstack.org/cgit/openstack/openstack-manuals
 * file bugs at: https://bugs.launchpad.net/openstack-manuals
-* Find more on documentation team processes hereː https://wiki.openstack.org/wiki/Documentation/HowTo
+* source: https://github.com/openstack/openstack-manuals
+* Find more on documentation team processes hereː http://docs.openstack.org/contributor-guide/
 * ''OpenStack Cloud Administrator Guide''
 ** content: installation and administration information
 ** source files for glance related stuff
-*** doc/admin-guide-cloud/images
+***  openstack-manuals/doc/admin-guide/source/compute-images-instances.rst
 ***  (may be some other stuff, and files are occasionally split/reorganized)
-** posted at: http://docs.openstack.org/admin-guide-cloud/content/
+** posted at: http://docs.openstack.org/admin-guide/
 * "OpenStack Command-Line Interface Reference"
-** doc/cli-reference/ch_cli_glance_property_keys.xml (suggested values for common image properties)
+**  openstack-manuals/doc/cli-reference/source/glance_property_keys.rst (suggested values for common image properties)
-** doc/cli-reference/generated/ch_cli_glance_commands.xml (automatically generated from python-glanceclient help)
+**  openstack-manuals/doc/cli-reference/source/glance.rst (automatically generated from python-glanceclient help, so make changes in the glanceclient tree, not here)
-** posted at http://docs.openstack.org/cli-reference/content/
+** posted at http://docs.openstack.org/cli-reference/
 * "OpenStack Configuration Reference"
-** doc/config-reference/image-service
+** doc/config-reference/source/image-service
-** doc/common/tables/*glance* (automatically generated from glance config help strings)
+*** these are at least partially generated from the glance config files, so check with doc team about where to make changes
-** posted at: http://docs.openstack.org/icehouse/config-reference/content/
+** posted at: http://docs.openstack.org/mitaka/config-reference/
 * ''OpenStack Virtual Machine Image Guide'' (not glance-specific)
 ** content: how to obtain, create, and modify virtual machine images that are compatible with OpenStack
-** source: doc/image-guide
+** source: openstack-manuals/doc/image-guide/source/
-** posted at: http://docs.openstack.org/image-guide/content/
+** posted at: http://docs.openstack.org/image-guide/
 == End User Guide ==
-* also generated from XML files in https://github.com/openstack/openstack-manuals
+* source: openstack-manuals/doc/user-guide/source/
-** source files for glance-specific stuff:
+** (not sure what Glance content is in there ATM)
-*** doc/common/section_cli_glance_manage_images.xml
+* posted at: http://docs.openstack.org/user-guide/
-*** doc/common/section_sdk_glance_manage_images.xml
-*** doc/common/section_getstart_image.xml ''(I can't figure out where this content is posted)''
-* posted at: http://docs.openstack.org/user-guide/content/
 * file bugs at: http://bugs.launchpad.net/openstack-manuals
 <div style="margin-top:10ex">
-* For other projects, see https://wiki.openstack.org/wiki/Documentation/Builds#Documentation_source_and_target_locations
+* For other projects, see http://docs.openstack.org/contributor-guide/docs-builds.html#documentation-source-and-target-locations
 * For general documentation project info, see https://wiki.openstack.org/wiki/Documentation
 * Also, join #openstack-doc on Freenode for real time answers to questions.
 </div>