Difference between revisions of "Blueprint-restructure-documentation"
(→Design) |
m (→Design) |
||
Line 63: | Line 63: | ||
|} | |} | ||
+ | == Goals == | ||
The restructure aims to create the following main documents: | The restructure aims to create the following main documents: | ||
Line 68: | Line 69: | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
− | ! - !! | + | ! - !! OpenStack Installation Guide !! OpenStack Operations Guide !! OpenStack Reference !! OpenStack API Reference || OpenStack User Guide || Developing OpenStack |
+ | |- | ||
+ | | Audience | ||
+ | || Deployers | ||
+ | || Deployers | ||
+ | || Administrators | ||
+ | || Developers | ||
+ | || Users | ||
+ | || Developers | ||
|- | |- | ||
| Purpose | | Purpose |
Revision as of 14:11, 14 May 2013
- Launchpad Entry: restructure-documentation
- Created: Tom Fifield
- Contributors: Diane Fleming
Summary
The OpenStack library was designed a few years ago. Since then, the library has grown without a specific organization. Also, we 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.
Design
Audience | Existing document | Planned document |
---|---|---|
Users | OpenStack API Quick Start | OpenStack User Guide |
Users | Programming OpenStack Compute API with Shell and Python | OpenStack User Guide |
Users | API Specifications | OpenStack User Guide |
Developers | API Complete Reference | API Reference |
Deployers | Basic Installation Guide for Ubuntu 12.04/12.10 (Folsom) | OpenStack Installation Guide, OpenStack Operations Guide |
Deployers | Install and Deploy Guide for Ubuntu 12.10 (Folsom) | OpenStack Installation Guide, OpenStack Operations Guide |
Deployers | Install and Deploy Guide for Red Hat Enterprise Linux, CentOS 6.x, or Fedora 17 (Folsom) | OpenStack Installation Guide, OpenStack Operations Guide |
Deployers | OpenStack Networking (Quantum) Installation | IOpenStack Installation Guide |
Administrators | Compute Administration Guide | OpenStack Installation Guide, OpenStack Operations Guide |
Administrators | Network Administration Guide | OpenStack Installation Guide, OpenStack Operations Guide |
Administrators | Object Storage Administration Guide | OpenStack Installation Guide, OpenStack Operations Guide |
Administrators | OpenStack Operations Guide | OpenStack Operations Guide |
Developers | Python Developer Documentation | Users Manual |
Developers | Language Bindings Documentation | Users Manual |
Developers | Continuous Integration (CI) Developer Documentation | Developing OpenStack |
Users | OpenStack Clients Guide | OpenStack Command Reference |
All | OpenStack Glossary | All guides and references |
Developers | Nova devref | Developing OpenStack |
Developers | Swift devref | Developing OpenStack, Operations Guide, Installation Guide, Reference Manual, Users Manual |
Developers | Keystone devref | Developing OpenStack, Operations Guide, Installation Guide, Reference Manual, Users Manual |
Developers | Glance devref | Developing OpenStack, Operations Guide, Installation Guide, Reference Manual, Users Manual |
Developers | Horizon devref | Developing OpenStack, Operations Guide, Installation Guide, Reference Manual, Users Manual |
Developers | Cinder devref | Developing OpenStack |
Goals
The restructure aims to create the following main documents:
- | OpenStack Installation Guide | OpenStack Operations Guide | OpenStack Reference | OpenStack API Reference | OpenStack User Guide | Developing OpenStack |
---|---|---|---|---|---|---|
Audience | Deployers | Deployers | Administrators | Developers | Users | Developers |
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