Difference between revisions of "Documentation"
(Separated software doc and project doc) |
(Splitting into two columns to try to bring project documentation above the "fold.") |
||
| 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 soon glance.openstack.org. We're developing docs.openstack.org for the Bexar release in Feb 2011. | |
| + | |||
| + | <<Columns(2, start)>> | ||
| + | |||
| + | = [[OpenStack]] draft manuals = | ||
| + | |||
| + | == Administration and Deployment == | ||
We write draft documentation on the wiki or in Etherpad. These manuals are drafts on the wiki, ready for writing: | We write draft documentation on the wiki or in Etherpad. These manuals are drafts on the wiki, ready for writing: | ||
| Line 66: | Line 72: | ||
== Glossary == | == Glossary == | ||
* [[Glossary]] - Contains terms that are our definitions for [[OpenStack]], cloud computing, and open source. | * [[Glossary]] - Contains terms that are our definitions for [[OpenStack]], cloud computing, and open source. | ||
| − | + | <<Columns(2)>> | |
= Project documentation = | = Project documentation = | ||
| Line 86: | Line 92: | ||
* [[BugsLifecycle|Bugs lifecycle]] | * [[BugsLifecycle|Bugs lifecycle]] | ||
* [[LaunchpadGroups|Launchpad groups]] | * [[LaunchpadGroups|Launchpad groups]] | ||
| + | |||
| + | <<Columns(2, end)>> | ||
---- | ---- | ||
[[Category:HowTo]] | [[Category:HowTo]] | ||
Revision as of 03:20, 29 December 2010
<<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 soon glance.openstack.org. We're developing docs.openstack.org for the Bexar release in Feb 2011.
<<Columns(2, start)>>
OpenStack draft manuals
Administration and Deployment
We write draft documentation on the wiki or in Etherpad. These manuals are drafts on the wiki, ready for writing:
- [[[NovaAdminManual||OpenStack] Compute Administration Manual ]]
- [[[NovaDeploymentManual|| OpenStack] Compute Deployment Manual ]]
- [[[NovaUserManual|| OpenStack] Compute End User Manual ]]
These guides are available and sourced in .rst files in /doc/source/ if you want to work on them:
- OpenStack Object Storage (Swift) Administrator's Guide
- OpenStack Object Storage (Swift) Deployment Guide
- OpenStack Compute (Nova) Administration Guide
- OpenStack Compute (Nova) Developer Guide
Getting Started with OpenStack
How to evaluate OpenStack and the technology behind it.
- Release Notes for the Austin release
- About OpenStack Object Storage (Swift)
- What is OpenStack Compute (Nova)?
- [[[GettingImages|| Guidelines for Images for OpenStack] Compute (Nova)]]
- Quickstart Guide
- Case studies
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 ]]]
- Compute (Nova) Installation, multiple machine
Configuration
How to configure Swift for object storage and Nova for managing cloud software.
- Configuring Object Storage (Swift)
- Flag Files for Nova
- Networking
- User Mode Linux
Security
Describes security, authorization, authentication, and trust management.
Troubleshooting
How to apply a process to troubleshooting when you see errors or problems.
Support
How to find or ask for support.
Glossary
<<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)>>
