Blueprint-restructure-documentation
- Launchpad Entry: restructure-documentation
- Created: Tom Fifield
- Contributors: Diane Fleming
Contents
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
Install and deploy a OpenStack cloud
Planned document | Take material from documents |
---|---|
OpenStack Installation Guide | OpenStack Basic Install Guide - Ubuntu 12.04 OpenStack Basic Install Guide - Fedora 18 |
OpenStack Operations Guide | OpenStack Operations Guide OpenStack <project> Administration Guide/s |
OpenStack Administration Reference | OpenStack <project> Administration Guide/s |
Use an OpenStack cloud
Existing documents | Planned document |
---|---|
OpenStack API Quick Start, Python Developer Documentation, Language Bindings Documentation, OpenStack Clients Guide | OpenStack User Guide |
OpenStack Clients Guide | OpenStack Command Reference |
OpenStack Glossary | All guides and references |
Develop applications with or extend OpenStack APIs
Existing documents | Planned document |
---|---|
OpenStack <project> API Dev Guides | OpenStack <project> API Specification |
API Complete Reference | API Reference |
Programming OpenStack Compute API with Shell and Python | OpenStack Compute API Developer Guide for Shell and Python |
Continuous Integration (CI) Developer Documentation | OpenStack Developer Guide |
Nova devref, Swift devref, Keystone devref, Glance devref, Horizon devref, Cinder devref | OpenStack Developer Guide, Operations Guide, Installation Guide, Administration Reference, User Guide |
Goals
The restructure aims to create the following main documents with the following goals:
- | Installation Guide | Operations Guide | Administration Reference | API Reference | User Guide | Developer Guide |
---|---|---|---|---|---|---|
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 implement.