Difference between revisions of "Blueprint-restructure-documentation"
(→Use) |
|||
Line 108: | Line 108: | ||
=== Use === | === Use === | ||
− | '''Audience''': Users of OpenStack clouds | + | '''Audience''': |
+ | * Users of OpenStack clouds who perform tasks through the Horizon dashboard or the OpenStack command-line clients. | ||
+ | * Developers who develop applications on top of OpenStack by using the OpenStack APIs. | ||
{| class="wikitable" | {| class="wikitable" | ||
Line 122: | Line 124: | ||
* <''project''> devref/s | * <''project''> devref/s | ||
|| | || | ||
− | + | Havana, 2013.1 | |
|| | || | ||
Yes | Yes | ||
Line 130: | Line 132: | ||
* OpenStack Clients Guide | * OpenStack Clients Guide | ||
|| | || | ||
− | + | Havana, 2013.1 | |
|| | || | ||
Yes | Yes | ||
Line 138: | Line 140: | ||
* OpenStack <''project''> API Specification/s | * OpenStack <''project''> API Specification/s | ||
|| | || | ||
− | API v | + | API v''n'' |
|| | || | ||
Yes | Yes | ||
Line 146: | Line 148: | ||
* API Complete Reference | * API Complete Reference | ||
|| | || | ||
− | API v | + | API v''n'' |
|| | || | ||
No | No |
Revision as of 14:51, 15 May 2013
- Launchpad Entry: restructure-documentation
- Created: Tom Fifield
- Contributors: Diane Fleming
Summary
The OpenStack documentation library was designed a few years ago. Since then, the library has grown without a specific organization. Also, doc contributors have learned how users interact with it.
This blueprint describes a plan to restructure the OpenStack documentation to reduce redundancy and increase usability, clarity, and consistency.
Goals
The restructure aims to create the following main documents with the following goals:
Title | Goals |
---|---|
OpenStack Installation Guide |
|
OpenStack Operations Guide |
|
OpenStack Configuration Reference |
|
OpenStack User Guide |
|
OpenStack Command Reference |
|
OpenStack Developer Guide |
|
OpenStack <project> API Specification |
|
OpenStack API Reference |
|
The following section details the restructure plan.
Design
Install, Configure, and Run
Audience: Deployers who want to install, configure, and run OpenStack clusters.
New title | Describes how to | Take material from | Release info | Include glossary? |
---|---|---|---|---|
OpenStack Installation Guide | Install and deploy an OpenStack cluster. |
|
Grizzly, 2013.1 |
Yes |
OpenStack Operations Guide | Design and operate OpenStack clusters. |
|
Grizzly, 2013.1 |
Yes |
OpenStack Configuration Reference | Configure OpenStack. |
|
Grizzly, 2013.1 |
Yes |
Use
Audience:
- Users of OpenStack clouds who perform tasks through the Horizon dashboard or the OpenStack command-line clients.
- Developers who develop applications on top of OpenStack by using the OpenStack APIs.
New title | Describes how to | Take material from | Release info | Include glossary? |
---|---|---|---|---|
OpenStack User Guide | Use an OpenStack cloud. |
|
Havana, 2013.1 |
Yes |
OpenStack Command Reference | Run OpenStack client commands on an OpenStack cloud. |
|
Havana, 2013.1 |
Yes |
OpenStack <project> API Specification/s | Write applications by using, review, or extend the OpenStack APIs. |
|
API vn |
Yes |
OpenStack API Reference | Write applications by using or extend OpenStack APIs. |
|
API vn |
No |
Develop
Audience: Developers who want to extend OpenStack.
New title | Describes how to | Take material from | Release info | Include glossary? |
---|---|---|---|---|
OpenStack Developer Guide | Develop OpenStack. |
|
API v<n> |
Yes |
Issues
- Lack of people to implement.