Difference between revisions of "Blueprint-restructure-documentation"
(→Goals) |
(→Goals) |
||
Line 20: | Line 20: | ||
|| | || | ||
* Provide step-by-step instructions for ''deployers'' about how to install, configure, and run OpenStack clusters. | * Provide step-by-step instructions for ''deployers'' about how to install, configure, and run OpenStack clusters. | ||
− | * Include | + | * Include 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, and; an introduction to the OpenStack community, including how to get help. |
− | |||
− | |||
− | |||
* Exclude unusual deployment scenarios. | * Exclude unusual deployment scenarios. | ||
|- | |- | ||
Line 34: | Line 31: | ||
|| | || | ||
* List configuration options available with OpenStack. | * List configuration options available with OpenStack. | ||
− | * Include | + | * Include configuration files, configuration options in each file, configuration extensions, and use cases for each configuration feature. |
− | |||
− | |||
− | |||
− | |||
* Exclude API parameters. | * Exclude API parameters. | ||
|- | |- | ||
Line 44: | Line 37: | ||
|| | || | ||
* Explain OpenStack cloud concepts and describe how to use an OpenStack cloud. | * Explain OpenStack cloud concepts and describe how to use an OpenStack cloud. | ||
− | * Include | + | * Include command-line tools and credentials, how to use Horizon dashboard, and how to create images. |
− | |||
− | |||
− | |||
* Exclude Cloud application architecture. | * Exclude Cloud application architecture. | ||
|- | |- | ||
Line 53: | Line 43: | ||
|| | || | ||
* Describe command-line clients and their subcommands and required and optional parameters. | * Describe command-line clients and their subcommands and required and optional parameters. | ||
− | * Exclude | + | * Exclude concepts (these go in the ''OpenStack User Guide'') or installation instructions (these go in the ''OpenStack Installation Guide''). |
− | |||
− | |||
|- | |- | ||
| ''OpenStack Developer Guide'' | | ''OpenStack Developer Guide'' | ||
Line 69: | Line 57: | ||
|| | || | ||
* Provide ''developers'' with a searchable and comprehensive Web page that lists API methods and parameters, with examples for each. | * Provide ''developers'' with a searchable and comprehensive Web page that lists API methods and parameters, with examples for each. | ||
− | * Exclude | + | * Exclude advanced guidance information (this goes in the ''OpenStack <project> API Specification/s''), installation instructions, or feature descriptions that are longer than one sentence. |
− | |||
− | |||
− | |||
|} | |} | ||
Revision as of 17:53, 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 | 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.