Difference between revisions of "Documentation"
(Fixing Image service reference) |
|||
| Line 30: | Line 30: | ||
* [http://swift.openstack.org/development_guidelines.html OpenStack Object Storage (Swift) Development Guidelines] | * [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 | + | * [http://glance.openstack.org/#developer-docs OpenStack Image 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 22:13, 21 November 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
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
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 Image 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 ]]]
- Compute (Nova) Installation
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)>>
