Jump to: navigation, search

Difference between revisions of "Documentation"

Line 1: Line 1:
{| style="color:#000000; border:solid 1px #A8A8A8; padding:0.5em; margin:0.5em 0; background-color:#FFFFFF;font-size:95%; vertical-align:middle;"
<!--{| style="color:#000000; border:solid 1px #A8A8A8; padding:0.5em; margin:0.5em 0; background-color:#FFFFFF;font-size:95%; vertical-align:middle;"
| style="padding:1em;width: 40px" | [[File:Drowning_noun_project_4285.svg|40px]]
| style="padding:1em;width: 40px" | [[File:Drowning_noun_project_4285.svg|40px]]
| '''Join Our Bug Day'''
| '''Join Our Bug Day'''
We need your help.
We need your help.
Join our [[Documentation/BugDay|Documentation Bug Day]] on Friday 20th December, 2013.
Join our [[Documentation/BugDay|Documentation Bug Day]] on Friday 20th December, 2013.

Revision as of 02:55, 21 December 2013

Documentation is community-oriented and available for different audiences on several websites - this wiki is for project or release documentation, the developer documentation for the projects is on docs.openstack.org/developer for example. For official documentation, see docs.openstack.org. To log a bug against the documentation, go to http://bugs.launchpad.net/openstack-manuals or http://bugs.launchpad.net/openstack-api-site.

There's also an OpenStack documentation mailing list and IRC channel at #openstack-doc.

The Documentation Program Technical Lead (PTL) is Anne Gentle.

OpenStack documentation

OpenStack API reference and specifications

Published doc Source repository
API Reference https://github.com/openstack/api-site/tree/master/api-ref
Block Storage Service API v2 Reference https://github.com/openstack/volume-api/tree/master/v2
Block Storage Service API v1 Reference (N/A) https://github.com/openstack/volume-api/tree/master/v1
Compute API v2 and Extensions Reference https://github.com/openstack/compute-api
Identity Service API v2.0 Reference https://github.com/openstack/identity-api
Networking API v2.0 Reference https://github.com/openstack/netconn-api
Image Service API v2 Reference https://github.com/openstack/image-api/tree/master/openstack-image-service-api/src/markdown
Image Service API v1 Reference https://github.com/openstack/image-api/tree/master/openstack-image-service-api/src/docbkx
Object Storage API v1 Reference https://github.com/openstack/object-api

OpenStack administration and configuration guides

Published doc Source repository
Configuration Reference https://github.com/openstack/openstack-manuals/tree/master/doc/config-reference
Cloud Administrator Guide https://github.com/openstack/openstack-manuals/tree/master/doc/admin-guide-cloud
High Availability Guide https://github.com/openstack/openstack-manuals/tree/master/doc/high-availability-guide
Operations Guide https://github.com/openstack/operations-guide
Security Guide https://github.com/openstack/openstack-manuals/tree/master/doc/security-guide
Virtual Machine Image Guide https://github.com/openstack/openstack-manuals/tree/master/doc/image-guide

OpenStack installation guides

Published doc Source repository
Installation Guide for Debian 7.0 https://github.com/openstack/openstack-manuals/tree/master/doc/install-guide
Installation Guide for openSUSE and SUSE Linux Enterprise Server https://github.com/openstack/openstack-manuals/tree/master/doc/install-guide
Installation Guide for Red Hat Enterprise Linux, CentOS, and Fedora https://github.com/openstack/openstack-manuals/tree/master/doc/install-guide
Installation Guide for Ubuntu 12.04 (LTS) Server https://github.com/openstack/openstack-manuals/tree/master/doc/install-guide

OpenStack user guides

Published doc Source repository
API Quick Start https://github.com/openstack/api-site/tree/master/api-quick-start
End User Guide https://github.com/openstack/openstack-manuals/tree/master/doc/user-guide
Admin User Guide https://github.com/openstack/openstack-manuals/tree/master/doc/user-guide-admin

Source Repositories

Doc source is on GitHub. Everyone can propose merges to docs, see Documentation/HowTo. Here are the repositories that build to docs.openstack.org.

For a complete listing of which docs are built, including details about source and target locations, see Documentation/Builds.


These guides are available and sourced in .rst files in /doc/source/ if you want to work on them:

Ideally the above content is geared towards developers.

The content at docs.openstack.org is for OpenStack administrators and application developers.


Lists current development release and past releases, with links to downloads and release notes (what's new and what's changed in each release as well as known issues and potential workarounds)


How to find or ask for support.


  • Glossary - Contains terms that are our definitions for OpenStack, cloud computing, and open source.

Project documentation


How to contribute code to OpenStack or develop using the OpenStack projects.

Launchpad reference

How we use Launchpad to track features, bugs and releases.

Writing documentation