Jump to: navigation, search


This info is accurate as of 23 June 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

API Reference Documentation

API Reference (Narrative style)

Glance installation guide

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 RST files that provide introductions to sections of the document
      • the content displaying the options is generated from where the options are defined in the Glance code
      • corrections/clarifications to the option descriptions must be corrected in the Glance code
    • 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