Jump to: navigation, search

Documentation/ContentSpecs

< Documentation
Revision as of 19:28, 20 March 2015 by Annegentle (talk | contribs) (Licenses)

Release specific documentation

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

Installation Guides

The OpenStack Installation Guides describe a manual install process, as in, by hand, no automation, for multiple distributions based on packaging system:

Guides for deployers and administrators

OpenStack Configuration Reference: Contains a reference listing of all configuration options for core and integrated OpenStack services by release version.

Continuously released documentation

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

  • Operations Guide: Icehouse target, revised specifically to target that release
  • Security Guide: written prior to Havana 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 Admin User Guide: Shows OpenStack administrators how to create and manage resources in an OpenStack cloud with the OpenStack dashboard and OpenStack client commands.
  • OpenStack API Quick Start: 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 Cloud Administrator Guide: Apache 2.0 and CC-by-sa 3.0
  • OpenStack High Availability Guide: Apache 2.0
  • OpenStack Configuration Reference: 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
  • OpenStack Admin 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