Jump to: navigation, search

Difference between revisions of "Documentation"

(Development)
(OpenStack documentation)
Line 27: Line 27:
 
* [http://docs.openstack.org/api/openstack-block-storage/2.0/content/ OpenStack Block Storage Developer Guide API 2.0]
 
* [http://docs.openstack.org/api/openstack-block-storage/2.0/content/ OpenStack Block Storage Developer Guide API 2.0]
  
== Administration and configuration ==
+
== OpenStack administration and configuration ==
* [http://docs.openstack.org/havana/config-reference/content/ Configuration Reference]   
+
{| class="wikitable sortable"
* [http://docs.openstack.org/admin-guide-cloud/content/ Cloud Administrator Guide]   
+
|-
* [http://docs.openstack.org/high-availability-guide/content/index.html High Availability Guide]  
+
! Document !! Published doc !! Source repository
* [http://docs.openstack.org/ops/ Operations Guide]  
+
|-
* [http://docs.openstack.org/security-guide/content/ Security Guide]  
+
| Configuration Reference || [http://docs.openstack.org/havana/config-reference/content/ Configuration Reference]  || https://github.com/openstack/openstack-manuals/tree/master/doc/config-reference
* [http://docs.openstack.org/image-guide/content/ Virtual Machine Image Guide]
+
|-
 +
| Cloud Administrator Guide || [http://docs.openstack.org/admin-guide-cloud/content/ Cloud Administrator Guide]  || https://github.com/openstack/openstack-manuals/tree/master/doc/admin-guide-cloud
 +
|-
 +
| High Availability Guide || [http://docs.openstack.org/high-availability-guide/content/index.html High Availability Guide] || https://github.com/openstack/openstack-manuals/tree/master/doc/high-availability-guide
 +
|-
 +
| Operations Guide || [http://docs.openstack.org/ops/ Operations Guide] || https://github.com/openstack/operations-guide
 +
|-
 +
| Security Guide || [http://docs.openstack.org/security-guide/content/ Security Guide] || https://github.com/openstack/openstack-manuals/tree/master/doc/security-guide
 +
|-
 +
| Virtual Machine Image Guide || [http://docs.openstack.org/image-guide/content/ Virtual Machine Image Guide] || https://github.com/openstack/openstack-manuals/tree/master/doc/image-guide
 +
|-
 +
|}
 +
  
== User guides ==
+
=== Source repository ===
 +
*  - Installation, administration, configuration, and user guides
 +
 
 +
== OpenStack user guides ==
 
* [http://docs.openstack.org/user-guide/content/ End User Guide]
 
* [http://docs.openstack.org/user-guide/content/ End User Guide]
 
* [http://docs.openstack.org/user-guide-admin/content/ Admin User Guide]
 
* [http://docs.openstack.org/user-guide-admin/content/ Admin User Guide]

Revision as of 18:04, 11 December 2013

Drowning noun project 4285.svg Join Our Bug Day

We need your help. Join our Documentation Bug Day on Friday 20th December, 2013.


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 documentation

OpenStack APIs

API reference documentation

API specifications

OpenStack administration and configuration

Document Published doc Source repository
Configuration Reference Configuration Reference https://github.com/openstack/openstack-manuals/tree/master/doc/config-reference
Cloud Administrator Guide Cloud Administrator Guide https://github.com/openstack/openstack-manuals/tree/master/doc/admin-guide-cloud
High Availability Guide High Availability Guide https://github.com/openstack/openstack-manuals/tree/master/doc/high-availability-guide
Operations Guide Operations Guide https://github.com/openstack/operations-guide
Security Guide Security Guide https://github.com/openstack/openstack-manuals/tree/master/doc/security-guide
Virtual Machine Image Guide Virtual Machine Image Guide https://github.com/openstack/openstack-manuals/tree/master/doc/image-guide


Source repository

  • - Installation, administration, configuration, and user guides

OpenStack user guides

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