openstack-manuals/doc/contributor-guide/source/content-specs.rst

7.1 KiB

Content specification

Release-specific documentation

The Installation Guides, Configuration Reference, and Networking Guide are released at release time, with draft material published to docs.openstack.org/draft/draft-index.html. The rest of the guides are continuously released.

To patch for the release-specific documentation, you should generally patch to master branch with "backport: xxxx" (for example, backport: kilo) in the commit message.

Installation Guides

The OpenStack Installation Guide describes a manual install process for multiple distributions based on the following packaging systems:

Guides for deployers and administrators

Continuously released documentation

These guides cover multiple versions and we follow the general release information. The guides cover the latest two versions, for example Juno and Kilo. The following exceptions apply:

  • Operations Guide: Icehouse target, revised specifically to target that release
  • HA Guide: Updated last at Havana timeframe, still needs updates

Guides for deployers and administrators

Guides for end users

  • OpenStack End User Guide: Shows OpenStack end users how to create and manage resources in an OpenStack cloud with the OpenStack dashboard and OpenStack client commands.
  • OpenStack API Guide: A brief overview of how to send REST API requests to endpoints for OpenStack services.
  • Command-Line Interface Reference: Automatically generates help text for CLI commands and subcommands.

API documentation

Guides for contributors

  • Infrastructure User Manual: Reference documentation for tools and processes used for all contributors to OpenStack projects. It includes instructions on how to create all the necessary accounts, setup development environment, use gerrit review workflow. The manual also covers more advanced topics, like how to create new git repositories. The manual is maintained by the OpenStack Infrastructure team.

Licenses

This section shows the license indicators as of March 20, 2015.

  • OpenStack Architecture Design Guide: Apache 2.0 and CC-by-sa 3.0
  • OpenStack Administrator Guide: Apache 2.0 and CC-by-sa 3.0
  • OpenStack Install Guides (all): Apache 2.0
  • OpenStack High Availability Guide: Apache 2.0
  • OpenStack Configuration Reference: Apache 2.0
  • OpenStack Networking Guide: Apache 2.0
  • OpenStack Security Guide: CC-by 3.0
  • Virtual Machine Image Guide: CC-by 3.0
  • OpenStack Operations Guide: CC-by 3.0
  • OpenStack End User Guide: CC-by 3.0
  • Command-Line Interface Reference: CC-by 3.0
  • Contributor dev docs (docs.openstack.org/developer/<projectname>): none indicated in output; Apache 2.0 in repo
  • OpenStack API Quick Start: none indicated in output; Apache 2.0 in repo
  • API Complete Reference: none indicated in output; Apache 2.0 in repo
  • Infrastructure User Manual: none indicated in output; CC-by 3.0 in repo

What to do to make more consistent output:

  • OpenStack Architecture Design Guide: Apache 2.0 and CC-by 3.0
  • OpenStack Administrator Guide: Apache 2.0 and CC-by 3.0
  • OpenStack Install Guides (all): Apache 2.0 and CC-by 3.0
  • OpenStack High Availability Guide: Apache 2.0 and CC-by 3.0
  • OpenStack Security Guide: CC-by 3.0
  • Virtual Machine Image Guide: CC-by 3.0
  • OpenStack Operations Guide: CC-by 3.0
  • OpenStack End User Guide: CC-by 3.0

These guides are created by "scraping" code:

  • OpenStack Configuration Reference: Apache 2.0 and CC-by 3.0
  • Command-Line Interface Reference: Apache 2.0 and CC-by 3.0

These guides have no indicator in output:

  • Contributor dev docs (docs.openstack.org/developer/<projectname>): none indicated in output; Apache 2.0 in repo
  • OpenStack API Quick Start: none indicated in output; Apache 2.0 in repo
  • API Complete Reference: none indicated in output; Apache 2.0 in repo

This guide has a review in place to get a license indicator in output:

  • Infrastructure User Manual: none indicated in output; CC-by 3.0 in repo