Difference between revisions of "Blueprint-restructure-documentation"
(→Design) |
(→Design) |
||
Line 69: | Line 69: | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
− | ! - !! Install Guide !! Operations Guide !! Reference Manual !! API Reference | + | ! - !! Install Guide !! Operations Guide !! Reference Manual !! API Reference || Users Manual || Developing OpenStack |
|- | |- | ||
| Purpose | | Purpose | ||
Line 76: | Line 76: | ||
|| The definitive list of options able to be used with OpenStack | || The definitive list of options able to be used with OpenStack | ||
|| The definitive list of API methods and parameters, with examples for each. | || The definitive list of API methods and parameters, with examples for each. | ||
+ | || Provide Application Developers all they need to understand about OpenStack to work with it. | ||
+ | || Provide the information needed to work on the code of OpenStack | ||
|- | |- | ||
| Inclusions | | Inclusions | ||
Line 87: | Line 89: | ||
* Every API method and every parameter | * Every API method and every parameter | ||
* Examples for every API method | * Examples for every API method | ||
+ | || | ||
+ | || | ||
|- | |- | ||
| Exclusions | | Exclusions | ||
Line 98: | Line 102: | ||
* Installation information | * Installation information | ||
* Descriptions of features > 1 sentence | * Descriptions of features > 1 sentence | ||
+ | || | ||
+ | || | ||
|} | |} | ||
Revision as of 06:47, 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
Current Document | Future document |
---|---|
OpenStack API Quick Start | Users Manual |
Programming OpenStack Compute API with Shell and Python | Users Manual |
API Specifications | Users Manual |
API Complete Reference | API Reference |
Basic Installation Guide for Ubuntu 12.04/12.10 (Folsom) | Installation Guide, Operations Guide |
Install and Deploy Guide for Ubuntu 12.10 (Folsom) | Installation Guide, Operations Guide |
Install and Deploy Guide for Red Hat Enterprise Linux, CentOS 6.x, or Fedora 17 (Folsom) | Installation Guide, Operations Guide |
OpenStack Networking (Quantum) Installation | Installation Guide |
Compute Administration Guide | Installation Guide, Operations Guide |
Network Administration Guide | Installation Guide, Operations Guide |
Object Storage Administration Guide | Installation Guide, Operations Guide |
OpenStack Operations Guide | OpenStack Operations Guide |
Python Developer Documentation | Users Manual |
Language Bindings Documentation | Users Manual |
Continuous Integration (CI) Developer Documentation | Developing OpenStack |
OpenStack Clients Guide | Users Manual |
OpenStack Glossary | All guides |
Nova devref | Developing OpenStack |
Swift devref | Developing OpenStack, Operations Guide, Installation Guide, Reference Manual, Users Manual |
Keystone devref | Developing OpenStack, Operations Guide, Installation Guide, Reference Manual, Users Manual |
Glance devref | Developing OpenStack, Operations Guide, Installation Guide, Reference Manual, Users Manual |
Horizon devref | Developing OpenStack, Operations Guide, Installation Guide, Reference Manual, Users Manual |
Cinder devref | Developing OpenStack |
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 | Users Manual | Developing OpenStack |
---|---|---|---|---|---|---|
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. | Provide Application Developers all they need to understand about OpenStack to work with it. | Provide the information needed to work on the code of OpenStack |
Inclusions | - | - |
|
|
||
Exclusions |
|
|
|
|
Issues
- Lack of people to realise