Difference between revisions of "Blueprint-restructure-documentation"
(→Develop) |
(→Develop) |
||
Line 143: | Line 143: | ||
* OpenStack <''project''> API Dev Guides | * OpenStack <''project''> API Dev Guides | ||
|| | || | ||
− | API v<'' | + | API v<''n''> |
|| | || | ||
Yes | Yes | ||
Line 151: | Line 151: | ||
* API Complete Reference | * API Complete Reference | ||
|| | || | ||
− | API v<'' | + | API v<''n''> |
|| | || | ||
No | No | ||
Line 161: | Line 161: | ||
* <project> devref/s | * <project> devref/s | ||
|| | || | ||
− | API v<'' | + | API v<''n''> |
|| | || | ||
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<n> |
Yes |
OpenStack API Reference | Write applications by using or extend OpenStack APIs. |
|
API v<n> |
No |
OpenStack Developer Guide | Develop code for OpenStack. |
|
API v<n> |
Yes |
Issues
- Lack of people to implement.