Difference between revisions of "Documentation"
Annegentle (talk | contribs) (Updates after wiki migration) |
Annegentle (talk | contribs) (→OpenStack software documentation) |
||
| Line 3: | Line 3: | ||
Documentation is community-oriented and available for different audiences on several websites - this wiki is for project or release documentation, the developer documentation for the projects is on [http://docs.openstack.org/developer/nova docs.openstack.org/developer] for example. For official documentation, see [http://docs.openstack.org docs.openstack.org]. To log a bug against the documentation, go to http://bugs.launchpad.net/openstack-manuals or http://bugs.launchpad.net/openstack-api-site. | Documentation is community-oriented and available for different audiences on several websites - this wiki is for project or release documentation, the developer documentation for the projects is on [http://docs.openstack.org/developer/nova docs.openstack.org/developer] for example. For official documentation, see [http://docs.openstack.org docs.openstack.org]. To log a bug against the documentation, go to http://bugs.launchpad.net/openstack-manuals or http://bugs.launchpad.net/openstack-api-site. | ||
| − | There's also an [http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs OpenStack documentation mailing list]. | + | There's also an [http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs OpenStack documentation mailing list] and IRC channel at #openstack-doc. |
= OpenStack Manuals = | = OpenStack Manuals = | ||
Revision as of 22:08, 16 February 2013
Contents
OpenStack software documentation
Documentation is community-oriented and available for different audiences on several websites - this wiki is for project or release documentation, the developer documentation for the projects is on docs.openstack.org/developer for example. For official documentation, see docs.openstack.org. To log a bug against the documentation, go to http://bugs.launchpad.net/openstack-manuals or http://bugs.launchpad.net/openstack-api-site.
There's also an OpenStack documentation mailing list and IRC channel at #openstack-doc.
OpenStack Manuals
OpenStack APIs
- http://api.openstack.org
- OpenStack API Quick Start
- Programming OpenStack Compute API with Shell and Python
- OpenStack Compute Developer Guide API 2
- OpenStack Image Service Developer Guide API 1.0
- OpenStack Object Storage Developer Guide API 1.0
- OpenStack Identity Service Developer Guide API 2.0
- Openstack Network Service Developer Guide API 2.0
Administration
- OpenStack Compute Administration Manual html pdf
- OpenStack Object Storage Administration Manual html pdf
- OpenStack Network Administration Manual (Quantum) html pdf
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/api-site
- 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
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
- OpenStack Identity Service (Keystone) Developer Docs
- OpenStack Networking (Quantum) 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)
Support
How to find or ask for support.
Glossary
- 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.
- How to Contribute
- Sign the Contributor agreement
- Design Tenets
- Explanation of the Release cycle
- Coding Standards
- Learning bzr and Launchpad
- Getting the Code (using Launchpad and bzr)
Launchpad reference
How we use Launchpad to track features, bugs and releases.
