Difference between revisions of "Blueprint-restructure-documentation"
(Created page with " * '''Launchpad Entry''': [https://blueprints.launchpad.net/openstack-manuals/+spec/restructure-documentation restructure-documentation] * '''Created''': Tom Fifield * '''Con...") |
(→Design) |
||
| Line 12: | Line 12: | ||
== Design == | == Design == | ||
| + | |||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | ! - !! 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 || Example || Example || Example || Example | ||
| + | |- | ||
| + | | Exclusions || Example || Example || Example || Example | ||
| + | |} | ||
| + | |||
== Issues == | == Issues == | ||
---- | ---- | ||
[[Category:Spec]] | [[Category:Spec]] | ||
Revision as of 06:21, 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
| - | 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 | Example | Example | Example | Example |
| Exclusions | Example | Example | Example | Example |
