Difference between revisions of "Blueprint-restructure-documentation"
(→Develop) |
|||
Line 108: | Line 108: | ||
=== Use === | === Use === | ||
− | '''Audience''': Users of OpenStack clouds. | + | '''Audience''': Users of OpenStack clouds, at the GUI, CLI or those who want to develop applications on top of OpenStack using the APIs. |
{| class="wikitable" | {| class="wikitable" | ||
Line 133: | Line 133: | ||
|| | || | ||
Yes | Yes | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| ''OpenStack <project> API Specification/s'' || Write applications by using, review, or extend the OpenStack APIs. | | ''OpenStack <project> API Specification/s'' || Write applications by using, review, or extend the OpenStack APIs. | ||
Line 159: | Line 150: | ||
No | No | ||
|- | |- | ||
− | | ''OpenStack Developer Guide'' || Develop | + | |} |
+ | |||
+ | === Develop === | ||
+ | '''Audience''': Developers who want to extend OpenStack. | ||
+ | |||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! New title !! Describes how to !! Take material from !! Release info !! Include glossary? | ||
+ | |- | ||
+ | | ''OpenStack Developer Guide'' || Develop OpenStack. | ||
|| | || | ||
* Continuous Integration (CI) Developer Documentation | * Continuous Integration (CI) Developer Documentation |
Revision as of 21:40, 14 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, at the GUI, CLI or those who want to develop applications on top of OpenStack using the APIs.
New title | Describes how to | Take material from | Release info | Include glossary? |
---|---|---|---|---|
OpenStack User Guide | Use an OpenStack cloud. |
|
Grizzly, 2013.1 |
Yes |
OpenStack Command Reference | Run OpenStack client commands on an OpenStack cloud. |
|
Grizzly, 2013.1 |
Yes |
OpenStack <project> API Specification/s | Write applications by using, review, or extend the OpenStack APIs. |
|
API v<n> |
Yes |
OpenStack API Reference | Write applications by using or extend OpenStack APIs. |
|
API v<n> |
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.