Jump to: navigation, search

Difference between revisions of "Documentation"

(Development)
(Updates after wiki migration)
Line 1: Line 1:
 
= OpenStack software documentation =
 
= 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 [http://nova.openstack.org/ nova.openstack.org], [http://swift.openstack.org/ swift.openstack.org], [http://keystone.openstack.org/ keystone.openstack.org], and [http://glance.openstack.org glance.openstack.org]. For official documentation, see [http://docs.openstack.org docs.openstack.org]. To log a bug against the documentation, go to http://bugs.launchpad.net/openstack-manuals.
+
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 [http://docs.openstack.org/developer/nova docs.openstack.org/developer] for example. For official documentation, see [http://docs.openstack.org 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 [http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs OpenStack documentation mailing list].
 
There's also an [http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs OpenStack documentation mailing list].
Line 27: Line 27:
 
Doc source is on GitHub. Everyone can propose merge to docs. Here are the repositories that build to docs.openstack.org.
 
Doc source is on GitHub. Everyone can propose merge to docs. Here are the repositories that build to docs.openstack.org.
 
* http://github.com/openstack/openstack-manuals
 
* http://github.com/openstack/openstack-manuals
 +
* http://github.com/openstack/api-site
 
* http://github.com/openstack/compute-api
 
* http://github.com/openstack/compute-api
 
* http://github.com/openstack/identity-api
 
* http://github.com/openstack/identity-api
Line 36: Line 37:
  
 
These guides are available and sourced in .rst files in /doc/source/ if you want to work on them:
 
These guides are available and sourced in .rst files in /doc/source/ if you want to work on them:
* [http://swift.openstack.org/development_guidelines.html OpenStack Object Storage (Swift) Development Guidelines]
+
* [http://docs.openstack.org/developer/swift/development_guidelines.html OpenStack Object Storage (Swift) Development Guidelines]
* [http://nova.openstack.org/devref/index.html OpenStack Compute (Nova) Developer Guide]
+
* [http://docs.openstack.org/developer/nova/devref/index.html OpenStack Compute (Nova) Developer Guide]
* [http://glance.openstack.org/#developer-docs OpenStack Image Service (Glance) Developer Docs]
+
* [http://docs.openstack.org/developer/glance/ OpenStack Image Service (Glance) Developer Docs]
* [http://keystone.openstack.org/ OpenStack Identity Service (Keystone) Developer Docs]
+
* [http://docs.openstack.org/developer/keystone/ OpenStack Identity Service (Keystone) Developer Docs]
* [http://quantum.openstack.org/ OpenStack Network Service (Quantum) Developer Docs]
+
* [http://docs.openstack.org/developer/quantum/ OpenStack Networking (Quantum) Developer Docs]
  
 
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.  
 
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.  
Line 48: Line 49:
  
 
* [[Releases]]
 
* [[Releases]]
 
== Installation ==
 
How to install either Swift or Nova.
 
 
* [[SwiftInstall|Object Storage (Swift) Installation]]
 
* [[InstallInstructions/Nova|Compute (Nova) Installation]]
 
  
 
== Support ==
 
== Support ==

Revision as of 22:08, 16 February 2013

OpenStack software documentation

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.

OpenStack Manuals

OpenStack APIs

Administration

  • OpenStack Compute Administration Manual html pdf
  • OpenStack Object Storage Administration Manual html pdf
  • OpenStack Network Administration Manual (Quantum) html pdf

Source Repositories

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

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)

Support

How to find or ask for support.

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.

Launchpad reference

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

Writing documentation