Difference between revisions of "Documentation"
Line 3: | Line 3: | ||
= [[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], and [http://glance.openstack.org glance.openstack.org]. For official documentation, see [http://docs.openstack.org docs.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]. |
<<Columns(2, start)>> | <<Columns(2, start)>> | ||
Line 11: | Line 11: | ||
== Administration == | == Administration == | ||
− | * OpenStack Compute Administration Manual [http://docs.openstack.org/ | + | * 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 Object Storage Administration Manual [http://docs.openstack.org/ | + | * 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 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 == | ||
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/ | + | * [http://swift.openstack.org/development_guidelines.html OpenStack Object Storage (Swift) Development Guidelines] |
* [http://nova.openstack.org/devref/index.html OpenStack Compute (Nova) Developer Guide ] | * [http://nova.openstack.org/devref/index.html OpenStack Compute (Nova) Developer Guide ] | ||
+ | * [http://glance.openstack.org/#developer-docs OpenStack Identity Service (Glance) 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. |
Revision as of 20:41, 23 September 2011
<<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
Administration
- OpenStack Compute Administration Manual html pdf
- OpenStack Object Storage Administration Manual html pdf
- OpenStack Image Service Administration Manual html pdf
- OpenStack Identity Service Starter Manual html pdf
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 Identity Service (Glance) 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.
- [[[SwiftInstall|| Object Storage (Swift) Installation ]]]
- [[[NovaInstall|| Compute (Nova) Installation, single machine ]]]
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.
- [[[HowToContribute|| How to Contribute ]]]
- Sign the Contributor agreement
- Design Tenets
- [[[ReleaseCycle|| Explanation of the Release cycle ]]]
- Coding Standards
- [[[LifeWithBzrAndLaunchpad|| Learning bzr and Launchpad ]]]
- Getting the Code (using Launchpad and bzr)
Launchpad reference
How we use Launchpad to track features, bugs and releases.
<<Columns(2, end)>>