Difference between revisions of "Documentation/ContentSpecs"
Jaegerandi (talk | contribs) |
Jaegerandi (talk | contribs) |
||
| Line 1: | Line 1: | ||
{{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. | 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. | ||
| − | OpenStack Installation Guides: Describe a manual install process, as in, by hand, no automation, for multiple distributions based on packaging system: | + | * 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/ | + | ** [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/ | + | ** [http://docs.openstack.org/trunk/install-guide/install/apt/content/ Installation Guide for Ubuntu 12.04 and 14.04 (LTS) Server] |
| − | + | * [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. | |
| − | * [http://docs.openstack.org/ | ||
| − | |||
| − | * [http://docs.openstack.org/ | ||
| − | |||
| − | |||
| − | [http://docs.openstack.org/ | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | = Continously released documentation = | |
| + | == Guides for deployers and administrators == | ||
| − | [http://docs.openstack.org/ | + | * [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]] | ||
Revision as of 19:12, 1 June 2014
Contents
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.
- OpenStack Installation Guides: Describe a manual install process, as in, by hand, no automation, for multiple distributions based on packaging system:
- OpenStack Configuration Reference: Contains a reference listing of all configuration options for core and integrated OpenStack services by release version.
Continously released documentation
Guides for deployers and administrators
- 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.
- OpenStack High Availability Guide: Describes potential strategies for making your OpenStack services and related controllers and data stores highly available.
- OpenStack Security Guide: Provide best practices and conceptual information about securing an OpenStack cloud.
- Virtual Machine Image Guide: Shows you how to obtain, create, and modify virtual machine images that are compatible with OpenStack.
Guides for end users
- 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.
- 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.
- OpenStack API Quick Start: A brief overview of how to send REST API requests to endpoints for OpenStack services.
- Command-Line Interface Reference: Automatically generates help text for CLI commands and subcommands.
