Jump to: navigation, search

Difference between revisions of "Documentation/ContentSpecs"

(Continously released documentation)
 
(16 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
Read the new content in the [http://docs.openstack.org/contributor-guide/content-specs.html Documentation Contributor Guide].
 +
 
{{OpenStack_Documentation_Navbar}}
 
{{OpenStack_Documentation_Navbar}}
 
= Release specific documentation =
 
 
The Installation Guides and Configuration Reference are released at release time, with draft material published to docs.openstack.org/trunk/. The rest of the guides are continuously released.
 
 
== Installation Guides ==
 
The OpenStack Installation Guides describe a manual install process, as in, by hand, no automation, for multiple distributions based on packaging system:
 
* [http://docs.openstack.org/trunk/install-guide/install/apt-debian/content/ Installation Guide for Debian 7.0]
 
* [http://docs.openstack.org/trunk/install-guide/install/zypper/content/ Installation Guide for openSUSE and SUSE Linux Enterprise Server]
 
* [http://docs.openstack.org/trunk/install-guide/install/yum/content/ Installation Guide for Red Hat Enterprise Linux, CentOS, and Fedora]
 
* [http://docs.openstack.org/trunk/install-guide/install/apt/content/ Installation Guide for Ubuntu 12.04 and 14.04 (LTS) Server]
 
 
== Guides for deployers and administrators ==
 
[http://docs.openstack.org/trunk/config-reference/content/ OpenStack Configuration Reference]: Contains a reference listing of all configuration options for core and integrated OpenStack services by release version.
 
 
= Continously released documentation =
 
 
These guides cover multiple versions and we follow the general [[Releases|release information]]. The guides cover thus the latest two versions, for example Icehouse and Havana. The following exceptions apply:
 
* Operations Guide: Icehouse target, revised specifically to target that release
 
* Security Guide: written prior to Havana release
 
* HA Guide: updated last at Havana timeframe, still needs updates
 
 
== Guides for deployers and administrators ==
 
 
* [http://docs.openstack.org/arch-design/content OpenStack Architecture Design Guide]: Contains information on how to plan, design and architect an OpenStack cloud.
 
* [http://docs.openstack.org/admin-guide-cloud/content/ OpenStack Cloud Administrator Guide]: Contains how-to information for managing an OpenStack cloud as needed for your use cases, such as storage, computing, or software-defined-networking.
 
* [http://docs.openstack.org/high-availability-guide/content/index.html OpenStack High Availability Guide]: Describes potential strategies for making your OpenStack services and related controllers and data stores highly available.
 
* [http://docs.openstack.org/sec/ OpenStack Security Guide]: Provide best practices and conceptual information about securing an OpenStack cloud.
 
* [http://docs.openstack.org/image-guide/content/ Virtual Machine Image Guide]: Shows you how to obtain, create, and modify virtual machine images that are compatible with OpenStack.
 
 
== Guides for end users ==
 
 
* [http://docs.openstack.org/user-guide/content/ OpenStack End User Guide]: Shows OpenStack end users how to create and manage resources in an OpenStack cloud with the OpenStack dashboard and OpenStack client commands.
 
* [http://docs.openstack.org/user-guide-admin/content/ OpenStack Admin User Guide]: Shows OpenStack administrators how to create and manage resources in an OpenStack cloud with the OpenStack dashboard and OpenStack client commands.
 
* [http://docs.openstack.org/api/quick-start/content/ OpenStack API Quick Start]: A brief overview of how to send REST API requests to endpoints for OpenStack services.
 
*  [http://docs.openstack.org/cli-reference/content/ Command-Line Interface Reference]: Automatically generates help text for CLI commands and subcommands.
 
  
 
----
 
----
 
[[Category:Documentation]]
 
[[Category:Documentation]]

Latest revision as of 08:26, 27 October 2015

Read the new content in the Documentation Contributor Guide.