Difference between revisions of "Blueprint-restructure-documentation"
(→Goals) |
(→Develop) |
||
Line 137: | Line 137: | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
− | ! Planned document !! Describes how to !! Take material from !! Include glossary? | + | ! Planned document !! Describes how to !! Take material from !! Release info !! Include glossary? |
|- | |- | ||
− | | ''OpenStack <project> API Specification/s'' || Write applications by using, review, or extend OpenStack APIs. | + | | ''OpenStack <project> API Specification/s'' || Write applications by using, review, or extend the OpenStack APIs. |
|| | || | ||
− | * OpenStack <project> API Dev Guides | + | * OpenStack <''project''> API Dev Guides |
+ | || | ||
+ | API v<''version''> | ||
|| | || | ||
Yes | Yes | ||
Line 148: | Line 150: | ||
|| | || | ||
* API Complete Reference | * API Complete Reference | ||
+ | || | ||
+ | API v<''version''> | ||
|| | || | ||
No | No | ||
Line 156: | Line 160: | ||
* OpenStack Compute API Developer Guide for Shell and Python | * OpenStack Compute API Developer Guide for Shell and Python | ||
* <project> devref/s | * <project> devref/s | ||
+ | || | ||
+ | API v<''version''> | ||
|| | || | ||
Yes | Yes |
Revision as of 19:51, 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 |
|
Design
Install, Configure, and Run
Audience: Deployers who want to install, configure, and run OpenStack clusters.
Planned document | 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.
Planned document | Describes how to | Take material from | Release info | Include glossary? |
---|---|---|---|---|
OpenStack User Guide | Complete user tasks on an OpenStack cloud. |
|
Grizzly, 2013.1 |
Yes |
OpenStack Command Reference | Run OpenStack client commands on an OpenStack cloud. |
|
Grizzly, 2013.1 |
Yes |
Develop
Audience: Developers who want to develop applications with or extend OpenStack APIs.
Planned document | Describes how to | Take material from | Release info | Include glossary? |
---|---|---|---|---|
OpenStack <project> API Specification/s | Write applications by using, review, or extend the OpenStack APIs. |
|
API v<version> |
Yes |
OpenStack API Reference | Write applications by using or extend OpenStack APIs. |
|
API v<version> |
No |
OpenStack Developer Guide | Develop code for OpenStack. |
|
API v<version> |
Yes |
Issues
- Lack of people to implement.