Revision as of 02:22, 22 November 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.

OpenStack documentation

OpenStack APIs

API reference documentation

• OpenStack API Complete Reference
• OpenStack API Quick Start

API specifications

• OpenStack Compute Developer Guide API 2
• OpenStack Image Service Developer Guide API 1.0
• OpenStack Object Storage Developer Guide API 1.0
• OpenStack Identity Service Developer Guide API 2.0
• Openstack Network Service Developer Guide API 2.0
• OpenStack Block Storage Developer Guide API 2.0

Administration and configuration

• Configuration Reference
• Cloud Administrator Guide
• High Availability Guide
• Operations Guide
• Security Guide
• Virtual Machine Image Guide

User guides

• End User Guide
• Admin User Guide

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.

• http://github.com/openstack/openstack-manuals - Installation, administration, configuration, and user guides
• http://github.com/openstack/api-site - API Quick Start, API Reference page, and Programmers Guide for Compute API with Shell and Python
• http://github.com/openstack/compute-api - Compute Administration Guide
• http://github.com/openstack/database-api - Database Administration Guide
• http://github.com/openstack/identity-api - Identity Administration Guide
• http://github.com/openstack/image-api - Image Service Administration Guide
• http://github.com/openstack/object-api - Object Storage Administration Guide
• http://github.com/openstack/netconn-api - Networking Administration Guide
• http://github.com/openstack/volume-api - Block Storage Service Administration Guide
• https://github.com/openstack/operations-guide - Operations Guide

Development

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

• OpenStack Object Storage (Swift) Development Guidelines
• OpenStack Compute (Nova) Developer Guide
• OpenStack Image Service (Glance) Developer Docs
• OpenStack Identity Service (Keystone) Developer Docs
• OpenStack Networking (Quantum) Developer Docs
• OpenStack Block Storage (Cinder) Developer Docs
  

Ideally the above content is geared towards developers.

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

Releases

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)

• Releases

Support

How to find or ask for support.

• Mailing Lists
• OpenStack Community Q & A
• Ask OpenStack

Glossary

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

Project documentation

Development

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

• How to Contribute
• Sign the Contributor agreement
• Design Tenets
• Explanation of the Release cycle
• Coding Standards
• Getting the Code (using Launchpad and bzr)

Launchpad reference

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

• Blueprints
• Bugs
• Launchpad groups

Writing documentation

• How to contribute to the documentation
• Conventions to follow when writing documentation
• Documentation checklist
• Documentation build information
• DocImpact
• Troubleshooting doc builds
• Comments on Documentation