Difference between revisions of "Blueprint-restructure-documentation"
(→Develop) |
(→Goals) |
||
Line 22: | Line 22: | ||
<br/> | <br/> | ||
Includes: | Includes: | ||
− | * Easy to follow, lightweight command-by-command steps for installing an OpenStack cluster of defined architecture | + | * Easy to follow, lightweight command-by-command steps for installing an OpenStack cluster of defined architecture. |
* Basic explanatory text for command steps, enabling first time users to understand why they are performing them. | * Basic explanatory text for command steps, enabling first time users to understand why they are performing them. | ||
* An introduction to the OpenStack community, including how to get help. | * An introduction to the OpenStack community, including how to get help. | ||
<br/> | <br/> | ||
− | Excludes | + | Excludes unusual deployment scenarios. |
− | |||
|- | |- | ||
| ''OpenStack Operations Guide'' | | ''OpenStack Operations Guide'' | ||
Line 47: | Line 46: | ||
* Use cases for each configuration feature | * Use cases for each configuration feature | ||
<br/> | <br/> | ||
− | Excludes | + | Excludes API parameters. |
− | |||
|- | |- | ||
| ''OpenStack User Guide'' | | ''OpenStack User Guide'' | ||
Line 59: | Line 57: | ||
* How to create images | * How to create images | ||
<br/> | <br/> | ||
− | Excludes | + | Excludes Cloud application architecture. |
− | |||
|- | |- | ||
| ''OpenStack Command Reference'' | | ''OpenStack Command Reference'' | ||
Line 82: | Line 79: | ||
Explains API concepts and describes API methods and parameters, with examples for each. | Explains API concepts and describes API methods and parameters, with examples for each. | ||
<br/> | <br/> | ||
− | Includes | + | Includes advanced guidance information. |
− | |||
|- | |- | ||
| ''OpenStack API Reference'' | | ''OpenStack API Reference'' |
Revision as of 17:42, 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 |
Provide step-by-step instructions for deployers about how to install, configure, and run OpenStack clusters.
|
OpenStack Operations Guide |
Provide opinionated direction for deployers about how to design, set up, and run OpenStack clusters.
|
OpenStack Configuration Reference |
List configuration options available with OpenStack.
|
OpenStack User Guide |
Explain OpenStack cloud concepts and describe how to use an OpenStack cloud.
|
OpenStack Command Reference |
Describe command-line clients and their subcommands and required and optional parameters.
|
OpenStack Developer Guide |
Describe how to develop code for OpenStack. |
OpenStack <project> API Specification |
Explains API concepts and describes API methods and parameters, with examples for each.
|
OpenStack API Reference |
Provide developers with a searchable and comprehensive Web page that lists API methods and parameters, with examples for each.
|
Design
Install, Configure, and Run
Audience: Deployers who want to install, configure, and run OpenStack clusters.
Planned document | Describes how to | Take material from | Include glossary? |
---|---|---|---|
OpenStack Installation Guide | Install and deploy an OpenStack cluster. |
|
Yes |
OpenStack Operations Guide | Design and operate OpenStack clusters. |
|
Yes |
OpenStack Configuration Reference | Configure OpenStack. |
|
Yes |
Use
Audience: Users of OpenStack clouds.
Planned document | Describes how to | Take material from | Include glossary? |
---|---|---|---|
OpenStack User Guide | Complete user tasks on an OpenStack cloud. |
|
Yes |
OpenStack Command Reference | Run OpenStack client commands on an OpenStack cloud. |
|
Yes |
Develop
Audience: Developers who want to develop applications with or extend OpenStack APIs.
Planned document | Describes how to | Take material from | Include glossary? |
---|---|---|---|
OpenStack <project> API Specification/s | Write applications by using, review, or extend OpenStack APIs. |
|
Yes |
OpenStack API Reference | Write applications by using or extend OpenStack APIs. |
|
No |
OpenStack Developer Guide | Develop code for OpenStack. |
|
Yes |
Issues
- Lack of people to implement.