Jump to: navigation, search

Difference between revisions of "Documentation"

(Source Repositories)
(Writing documentation: Rename documentation conventions link, it's not just about markup anymore)
Line 94: Line 94:
  
 
* [[Documentation/HowTo|How to contribute to the documentation]]  
 
* [[Documentation/HowTo|How to contribute to the documentation]]  
* [[Documentation/Conventions|DocBook markup conventions]]
+
* [[Documentation/Conventions|Conventions to follow when writing documentation]]
 
* [[Documentation/Checklist|Documentation checklist]]
 
* [[Documentation/Checklist|Documentation checklist]]
 
* [[Documentation/Builds|Documentation build information]]
 
* [[Documentation/Builds|Documentation build information]]

Revision as of 01:49, 31 August 2013

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

Administration

  • OpenStack Compute Administration Guide html pdf
  • OpenStack Object Storage Administration Guide html pdf
  • OpenStack Networking Administration Guide html pdf

Source Repositories

Doc source is on GitHub. Everyone can propose merges to docs, see Documentation/HowTo. Here are the repositories that build to docs.openstack.org.

For a complete listing of which docs are built, including details about source and target locations, see Documentation/Builds.

Development

These guides are available and sourced in .rst files in /doc/source/ if you want to work on them:


Ideally the above content is geared towards developers.

The content at docs.openstack.org is for OpenStack administrators and application developers.

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.

Launchpad reference

How we use Launchpad to track features, bugs and releases.

Writing documentation