Jump to: navigation, search

Difference between revisions of "Documentation"

(Added a link to doc conventions)
(Updating diablo links to trunk, also adds all API reference info, also removes separate identity and image admin guides)
Line 17: Line 17:
 
* http://github.com/openstack/object-api
 
* http://github.com/openstack/object-api
 
* http://github.com/openstack/netconn-api
 
* http://github.com/openstack/netconn-api
 +
 +
== [[OpenStack]] APIs ==
 +
 +
* http://api.openstack.org
 +
* [http://docs.openstack.org/api/quick-start/content/  OpenStack API Quick Start]
 +
* [http://docs.openstack.org/api/openstack-compute/programmer/content/  Programming OpenStack Compute API with Shell and Python ]
 +
* [http://docs.openstack.org/api/openstack-compute/2/content/  OpenStack Compute Developer Guide API 2 ]
 +
* [http://docs.openstack.org/api/openstack-image-service/1.0/content/  OpenStack Image Service Developer Guide API 1.0]
 +
* [http://docs.openstack.org/api/openstack-object-storage/1.0/content/  OpenStack Object Storage Developer Guide API 1.0]
 +
* [http://docs.openstack.org/api/openstack-identity-service/2.0/content/  OpenStack Identity Service Developer Guide API 2.0]
  
 
== Administration ==
 
== Administration ==
  
* OpenStack Compute Administration Manual [http://docs.openstack.org/diablo/openstack-compute/admin/content/  html] [http://docs.openstack.org/diablo/openstack-compute/admin/os-compute-adminguide-trunk.pdf  pdf]
+
* OpenStack Compute Administration Manual [http://docs.openstack.org/trunk/openstack-compute/admin/content/  html] [http://docs.openstack.org/trunk/openstack-compute/admin/os-compute-adminguide-trunk.pdf  pdf]
* OpenStack Object Storage Administration Manual [http://docs.openstack.org/diablo/openstack-object-storage/admin/content/  html] [http://docs.openstack.org/diablo/openstack-object-storage/admin/os-objectstorage-adminguide-trunk.pdf  pdf]
+
* OpenStack Object Storage Administration Manual [http://docs.openstack.org/trunk/openstack-object-storage/admin/content/  html] [http://docs.openstack.org/trunk/openstack-object-storage/admin/os-objectstorage-adminguide-trunk.pdf  pdf]
* OpenStack Image Service Administration Manual [http://docs.openstack.org/diablo/openstack-image-service/admin/content/  html] [http://docs.openstack.org/diablo/openstack-image-service/admin/os-image-adminguide-trunk.pdf  pdf]
 
* OpenStack Identity Service Starter Manual [http://docs.openstack.org/diablo/openstack-identity-service/admin/content/  html] [http://docs.openstack.org/diablo/openstack-identity/admin/os-identity-starter-guide-trunk.pdf  pdf]
 
  
 
== Development ==
 
== Development ==
Line 78: Line 86:
 
== Writing documentation ==
 
== Writing documentation ==
  
 +
* [[Documentation/HowTo | How to contribute to the documentation]]
 
* [[Documentation/Conventions| DocBook markup conventions]]
 
* [[Documentation/Conventions| DocBook markup conventions]]
  

Revision as of 19:27, 9 April 2012

<<TableOfContents(2)>>

OpenStack software documentation

Documentation is community-oriented and available for different audiences on several websites - this wiki is for fast, changing documentation, the developer documentation for the projects is on nova.openstack.org, swift.openstack.org, keystone.openstack.org, and glance.openstack.org. For official documentation, see docs.openstack.org.

<<Columns(2, start)>>

OpenStack Manuals

Source Repositories

Doc source is on GitHub. Everyone can propose merge to docs. Here are the repositories that build to docs.openstack.org.

OpenStack APIs

Administration

  • OpenStack Compute Administration Manual html pdf
  • OpenStack Object Storage Administration Manual html pdf

Development

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

Ideally the content on the above sites is geared towards developers, and docs.openstack.org is for developer consumers of the ReST API and OpenStack administrators.

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)

Installation

How to install either Swift or Nova.

Support

How to find or ask for support.

Glossary

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

<<Columns(2)>>

Project documentation

Development

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

<<Columns(2, end)>>