Difference between revisions of "Documentation"
(Link cleanup) |
|||
| Line 11: | Line 11: | ||
== Administration == | == Administration == | ||
| − | * | + | * OpenStack Compute Administration Manual [http://docs.openstack.org/openstack-compute/admin/content/ html] [http://docs.openstack.org/openstack-compute/admin/os-compute-admin-book.pdf pdf] |
| + | * OpenStack Object Storage Administration Manual [http://docs.openstack.org/openstack-object-storage/admin/content/ html] [http://docs.openstack.org/openstack-object-storage/admin/os-objectstorage-admin-book.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/deployment_guide.html OpenStack Object Storage (Swift) Deployment Guide] | * [http://swift.openstack.org/deployment_guide.html OpenStack Object Storage (Swift) Deployment Guide] | ||
| − | |||
* [http://nova.openstack.org/devref/index.html OpenStack Compute (Nova) Developer Guide ] | * [http://nova.openstack.org/devref/index.html OpenStack Compute (Nova) Developer Guide ] | ||
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. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== Release Notes == | == Release Notes == | ||
| Line 45: | Line 39: | ||
* [http://docs.openstack.org/openstack-compute/admin/content/ch05s07.html Flag Files for Nova] | * [http://docs.openstack.org/openstack-compute/admin/content/ch05s07.html Flag Files for Nova] | ||
* [http://docs.openstack.org/openstack-compute/admin/content/ch04.html Networking] | * [http://docs.openstack.org/openstack-compute/admin/content/ch04.html Networking] | ||
| − | |||
| − | |||
| − | |||
== Troubleshooting == | == Troubleshooting == | ||
Revision as of 13:57, 15 March 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, 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
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.
Release Notes
Lists what's new and what's changed in each release as well as known issues and potential workarounds.
- [[[ReleaseNotes|| Release Notes]]]
Installation
How to install either Swift or Nova.
- [[[SwiftInstall|| Object Storage (Swift) Installation ]]]
- [[[NovaInstall|| Compute (Nova) Installation, single machine ]]]
Configuration
How to configure Swift for object storage and Nova for managing cloud software.
Troubleshooting
How to apply a process to troubleshooting when you see errors or problems.
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)>>
