Difference between revisions of "Documentation"
(Separated software doc and project doc) |
|||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | = [[OpenStack]] Manuals = | + | <<[[TableOfContents]](2)>> |
| + | = [[OpenStack]] software documentation = | ||
| + | |||
| + | == [[OpenStack]] Manuals == | ||
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 47: | Line 50: | ||
== Security == | == Security == | ||
Describes security, authorization, authentication, and trust management. | Describes security, authorization, authentication, and trust management. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== Troubleshooting == | == Troubleshooting == | ||
| Line 69: | Line 64: | ||
* [https://answers.launchpad.net/openstack Launchpad Answers] | * [https://answers.launchpad.net/openstack Launchpad Answers] | ||
| − | + | == 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. | ||
| + | |||
| + | = Project documentation = | ||
| + | |||
| + | == Development == | ||
| + | How to contribute code to [[OpenStack]] or develop using the [[OpenStack]] projects. | ||
| + | |||
| + | * [[[HowToContribute|| How to Contribute ]]] | ||
| + | * Sign the [[CLA|Contributor agreement]] | ||
| + | * [[BasicDesignTenets|Design Tenets]] | ||
| + | * [[[ReleaseCycle|| Explanation of the Release cycle ]]] | ||
| + | * [[CodingStandards|Coding Standards]] | ||
| + | * [[[LifeWithBzrAndLaunchpad|| Learning bzr and Launchpad ]]] | ||
| + | * [[GettingTheCode|Getting the Code (using Launchpad and bzr)]] | ||
| + | |||
| + | == Launchpad reference == | ||
| + | How we use Launchpad to track features, bugs and releases. | ||
| + | |||
| + | * [[BlueprintsLifecycle|Blueprints lifecycle]] | ||
| + | * [[BugsLifecycle|Bugs lifecycle]] | ||
| + | * [[LaunchpadGroups|Launchpad groups]] | ||
| + | |||
---- | ---- | ||
[[Category:HowTo]] | [[Category:HowTo]] | ||
Revision as of 09:51, 22 December 2010
<<TableOfContents(2)>>
OpenStack software documentation
OpenStack Manuals
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
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.
