Jump to: navigation, search

Difference between revisions of "Documentation"

m
Line 62: Line 62:
 
For a complete listing of which docs are built, including details about source and target locations, see [[Documentation/Builds]].
 
For a complete listing of which docs are built, including details about source and target locations, see [[Documentation/Builds]].
  
* http://git.openstack.org/cgit/openstack/openstack-manuals - Installation, administration, configuration, and user guides
+
* http://git.openstack.org/cgit/openstack/openstack-manuals - Installation, administration, configuration, architecture design guide and user guides
 
* http://git.openstack.org/cgit/openstack/api-site -  API Quick Start and API Complete Reference page
 
* http://git.openstack.org/cgit/openstack/api-site -  API Quick Start and API Complete Reference page
 
* http://git.openstack.org/cgit/openstack/operations-guide - Operations Guide
 
* http://git.openstack.org/cgit/openstack/operations-guide - Operations Guide

Revision as of 02:20, 20 July 2015


The focus here is the creation, maintenance and organization of the OpenStack documentation found at the http://docs.openstack.org site and the wiki.openstack.org site. While the Docs team helps create a good framework, it's the entire OpenStack community -- and especially contributors like you -- that provides the expert content and corrections for the documentation.

OpenStack Documentation Project Team
Full name OpenStack Documentation
Code name None
Status Related
Source code openstack-manuals; api-site - see doc builds for full list
Bug tracker http://bugs.launchpad.net/openstack-manuals and http://bugs.launchpad.net/openstack-api-site
Blueprints http://blueprints.launchpad.net/openstack-manuals
Developer doc Documentation HowTo
Current PTL Lana Brindley - openstack(at)lanabrindley(dot)com, IRC: loquacities
Meetings Documentation team meeting
IRC channel #openstack-doc on Freenode (more about OpenStack on IRC)
Mailing list OpenStack documentation mailing list

OpenStack documentation

Published docs and their location

The public interface to all documentation is the docs.openstack.org web site. It contains continuously updated manuals. If you like to edit one of these, see Documentation source and target locations for a list of documents and their source repositories.

Source repositories

Doc source is on GitHub. Everyone can propose changes 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

This is general information about OpenStack.

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

References

There are many additional publications about OpenStack by third party publishers. Please search for them on your favorite bookseller site.