Difference between revisions of "Blueprint-restructure-documentation"
(→Design) |
(→Design) |
||
| Line 25: | Line 25: | ||
|- | |- | ||
| Inclusions | | Inclusions | ||
| − | || | + | || - |
| − | || | + | || - |
|| | || | ||
* Every configuration option, in every configuration file | * Every configuration option, in every configuration file | ||
* A description of every feature's common scenario | * A description of every feature's common scenario | ||
| − | || | + | || |
| + | * Every API method and every parameter | ||
| + | * Examples for every API method | ||
|- | |- | ||
| Exclusions | | Exclusions | ||
|| | || | ||
* Unusual deployment scenarios | * Unusual deployment scenarios | ||
| − | || * Installation instructions | + | || |
| + | * Installation instructions | ||
|| API parameters | || API parameters | ||
|| Example | || Example | ||
Revision as of 06:26, 11 March 2013
- Launchpad Entry: restructure-documentation
- Created: Tom Fifield
- Contributors:
Contents
Summary
Restructure the documentation for greatest effectiveness.
Rationale
The original documentation layout for OpenStack was designed a couple of years ago. We have created a lot of documentation, and learnt much about how our various users interact with it. We now also have a new book: the OpenStack Operations Guide.
Design
The restructure considers 4 main documents. Each document may have other supporting documents, such as the "High Availability Guide", which supports both the Install Guide and the Operations Guide.
| - | Install Guide | Operations Guide | Reference Manual | API Reference |
|---|---|---|---|---|
| Purpose | Provide step-by-step instructions that allow result in an deployed OpenStack Cluster | Provide opinionated direction on the design and operations of OpenStack clusters | The definitive list of options able to be used with OpenStack | The definitive list of API methods and parameters, with examples for each. |
| Inclusions | - | - |
|
|
| Exclusions |
|
|
API parameters | Example |
