Difference between revisions of "Documentation"
(import cleanup) |
(import cleanup) |
||
| Line 1: | Line 1: | ||
| − | = | + | = 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 | + | 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. |
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]. | ||
| − | = | + | = OpenStack Manuals = |
| − | == | + | == OpenStack APIs == |
* http://api.openstack.org | * http://api.openstack.org | ||
| − | * [http://docs.openstack.org/api/quick-start/content/ | + | * [http://docs.openstack.org/api/quick-start/content/ OpenStack API Quick Start] |
| − | * [http://docs.openstack.org/api/openstack-compute/programmer/content/ | + | * [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/ | + | * [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/ | + | * [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/ | + | * [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/ | + | * [http://docs.openstack.org/api/openstack-identity-service/2.0/content/ OpenStack Identity Service Developer Guide API 2.0] |
| − | * [http://docs.openstack.org/api/openstack-network/2.0/content/ | + | * [http://docs.openstack.org/api/openstack-network/2.0/content/ Openstack Network Service Developer Guide API 2.0] |
== Administration == | == Administration == | ||
| − | * OpenStack Compute Administration Manual [http://docs.openstack.org/trunk/openstack-compute/admin/content/ | + | * 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/trunk/openstack-object-storage/admin/content/ | + | * 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 Network Administration Manual (Quantum) [http://docs.openstack.org/trunk/openstack-network/admin/content/ | + | * OpenStack Network Administration Manual (Quantum) [http://docs.openstack.org/trunk/openstack-network/admin/content/ html] [http://docs.openstack.org/trunk/openstack-network/admin/quantum-admin-guide-trunk.pdf pdf] |
== Source Repositories == | == Source Repositories == | ||
| Line 36: | Line 36: | ||
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 | + | * [http://swift.openstack.org/development_guidelines.html OpenStack Object Storage (Swift) Development Guidelines] |
| − | * [http://nova.openstack.org/devref/index.html | + | * [http://nova.openstack.org/devref/index.html OpenStack Compute (Nova) Developer Guide] |
| − | * [http://glance.openstack.org/#developer-docs | + | * [http://glance.openstack.org/#developer-docs OpenStack Image Service (Glance) Developer Docs] |
| − | * [http://keystone.openstack.org/ | + | * [http://keystone.openstack.org/ OpenStack Identity Service (Keystone) Developer Docs] |
| − | * [http://quantum.openstack.org/ | + | * [http://quantum.openstack.org/ OpenStack Network Service (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 52: | Line 52: | ||
How to install either Swift or Nova. | How to install either Swift or Nova. | ||
| − | * [[SwiftInstall| Object Storage (Swift) Installation ]] | + | * [[SwiftInstall|Object Storage (Swift) Installation]] |
| − | * [[InstallInstructions/Nova | Compute (Nova) Installation ]] | + | * [[InstallInstructions/Nova|Compute (Nova) Installation]] |
== Support == | == Support == | ||
| Line 87: | Line 87: | ||
== Writing documentation == | == Writing documentation == | ||
| − | * [[Documentation/HowTo | How to contribute to the documentation]] | + | * [[Documentation/HowTo|How to contribute to the documentation]] |
| − | * [[Documentation/Conventions| DocBook markup conventions]] | + | * [[Documentation/Conventions|DocBook markup conventions]] |
---- | ---- | ||
[[Category:HowTo]] | [[Category:HowTo]] | ||
Revision as of 21:12, 16 February 2013
Contents
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. To log a bug against the documentation, go to http://bugs.launchpad.net/openstack-manuals.
There's also an OpenStack documentation mailing list.
OpenStack Manuals
OpenStack APIs
- http://api.openstack.org
- OpenStack API Quick Start
- Programming OpenStack Compute API with Shell and Python
- 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
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.
- http://github.com/openstack/openstack-manuals
- http://github.com/openstack/compute-api
- http://github.com/openstack/identity-api
- http://github.com/openstack/image-api
- http://github.com/openstack/object-api
- http://github.com/openstack/netconn-api
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 Network Service (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.
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.
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
- Learning bzr and Launchpad
- Getting the Code (using Launchpad and bzr)
Launchpad reference
How we use Launchpad to track features, bugs and releases.
