OpenStack Documentation

Mission

• Provide documentation for core OpenStack projects to promote OpenStack.
• Develop and maintain tools and processes to ensure quality, accurate documentation.
• Treat documentation like OpenStack code.

Sites

• http://docs.openstack.org
• http://developer.openstack.org

Documentation team structure

• Specialty teams
  • API, Security Guide, Training Guides, Training Labs
• Docs cores and separate core teams for docs-specs , security-doc , training-guides , and training-labs
• Documentation cross-project liaisons for questions, reviews, doc bug triaging, and patching docs

Repositories

• Official deliverables with repositories
• Project repos can have installation tutorial and developer documentation
  • Example: Heat repository
    • Installation Tutorial (Ocata) is published from install-guide directory in stable/ocata branch
    • Developer documentation is published from doc directory in master branch

Bug reports

• https://bugs.launchpad.net/openstack-manuals
• https://bugs.launchpad.net/openstack-api-site
• https://bugs.launchpad.net/openstack-training-guides

Contributor guide

• http://docs.openstack.org/contributor-guide/index.html

This guide provides detailed instructions on the contribution workflow and conventions to be considered by all documentation contributors.

Building documentation

• http://docs.openstack.org/contributor-guide/docs-builds.html

Draft documentation, testing, and EOL

• https://docs.openstack.org/draft/draft-index.html
• Some documents (e.g., install-guides) require testing with releases
• EOL documents are not maintained in documentation repositories
  • See EOL status at: https://releases.openstack.org