Jump to: navigation, search

Difference between revisions of "Blueprint-restructure-documentation"

(Audiences: adding back Administration Guide)
 
(34 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
+
{{ImplementedFeature}}
 
* '''Launchpad Entry''':  [https://blueprints.launchpad.net/openstack-manuals/+spec/restructure-documentation restructure-documentation]
 
* '''Launchpad Entry''':  [https://blueprints.launchpad.net/openstack-manuals/+spec/restructure-documentation restructure-documentation]
 
* '''Created''': Tom Fifield
 
* '''Created''': Tom Fifield
Line 26: Line 26:
 
* ''OpenStack Operations Guide''  
 
* ''OpenStack Operations Guide''  
 
* ''OpenStack Configuration Reference''
 
* ''OpenStack Configuration Reference''
* ''OpenStack Configuration Guide''
+
* ''OpenStack Cloud Administrator Guide''
 
|-
 
|-
|  OpenStack users || Perform tasks in an OpenStack cloud through:
+
|  OpenStack end and admin users || Perform tasks in an OpenStack cloud through:
 
* The Horizon dashboard
 
* The Horizon dashboard
 
* The OpenStack command-line clients
 
* The OpenStack command-line clients
* Directly through the OpenStack APIs
+
* Directly through the OpenStack APIs - see the "OpenStack API Guide"
 
||  
 
||  
* ''OpenStack User Guide''
+
* ''OpenStack End User Guide''
* ''OpenStack Command Reference''
+
* ''OpenStack Admin User Guide''
 
|-
 
|-
| OpenStack developers || Extend the OpenStack APIs.<br />
+
| OpenStack contributors and application developers || Extend the OpenStack APIs.<br />
 
Write applications that run on top of an OpenStack cloud.
 
Write applications that run on top of an OpenStack cloud.
 
||   
 
||   
* ''OpenStack Developer Guide''
+
* ''OpenStack API Guide''
* ''OpenStack <project> API Specification/s''
+
* ''OpenStack API Complete Reference'' web pages - one page for each OpenStack project
* ''OpenStack API Reference'' web page
 
 
|}
 
|}
  
Line 97: Line 96:
 
* OpenStack ''project'' Administration Guide/s
 
* OpenStack ''project'' Administration Guide/s
 
* ''project'' devref/s
 
* ''project'' devref/s
 +
 +
=== OpenStack Cloud Administrator Guide ===
 +
 +
'''Purpose'''
 +
 +
* Provide guidance to day-to-day cloud administrators about how to perform administrative tasks.<br /><br />
 +
 +
'''Source  material'''
 +
 +
* OpenStack ''project'' Administration Guide/s
 +
* ''project'' devref/s
 +
 +
 +
'''Blueprints:''' [[Blueprint-os-admin-docs|Blueprint - OpenStack Administration Guide]], [[Blueprint-os-modularize-admin-docs|Blueprint - Modularize OpenStack Administration Guide]],
  
 
== Deliverables - Admin and End Users  ==
 
== Deliverables - Admin and End Users  ==
 
'''Audience''':  
 
'''Audience''':  
 
* Users of OpenStack clouds who perform tasks through the Horizon dashboard or the OpenStack command-line clients.  
 
* Users of OpenStack clouds who perform tasks through the Horizon dashboard or the OpenStack command-line clients.  
* Beginning developers who want to develop applications on top of OpenStack by using the OpenStack APIs.
+
* Beginning application developers who want to develop applications on top of OpenStack by using the OpenStack APIs.
 
<br />
 
<br />
 
'''Roadmap''':  
 
'''Roadmap''':  
Line 111: Line 124:
 
'''Include common glossary?''' Yes <br />
 
'''Include common glossary?''' Yes <br />
  
'''Blueprint:''' [[Blueprint-os-user-docs|Blueprint - OpenStack User Documentation]]
+
'''Blueprint:''' [[Blueprint-os-user-docs|Blueprint - OpenStack User Documentation]]  
 
 
=== OpenStack End User Guide ===
 
 
 
'''Purpose'''
 
  
* Explain OpenStack cloud concepts and describe how to use an OpenStack cloud.
+
=== OpenStack End User Guide (new) ===
* Include command-line tools and credentials, and how to use Horizon dashboard.
 
* Include OpenStack clients command reference as an appendix (or appendices).
 
:* Describe command-line clients and their subcommands and required and optional parameters.
 
:* Write scripts to auto-generate command and command parameters from the code.
 
:* Use conditional tags to generate two versions of this book: One with admin commands, and one without.
 
* Exclude concepts (these go in the ''OpenStack User Guide'') or installation instructions (these go in the ''OpenStack Installation Guide'').<br />
 
* Exclude Cloud application architecture.<br /><br />
 
  
'''Source  material'''
+
See [[Blueprint-os-user-docs|blueprint]] for details.
  
* [http://www.openstack.org/software/start/ OpenStack API Quick Start]
+
=== OpenStack Admin User Guide (new) ===
* [http://docs.openstack.org/developer/openstack-projects.html Python Developer Documentation]
 
* [http://docs.openstack.org/developer/language-bindings.html Language Bindings Documentation]
 
* [http://docs.openstack.org/cli/quick-start/content/index.html OpenStack Clients Guide]
 
* [http://docs.openstack.org/run/ OpenStack Administration Guides]
 
* [http://docs.openstack.org/api/api-specs.html OpenStack API Specifications]
 
* [http://docs.openstack.org/api/openstack-compute/programmer/content/ Programming OpenStack Compute API with Shell and Python]
 
* [http://docs.openstack.org/cli/quick-start/content/ OpenStack Clients Guide]
 
  
=== OpenStack Admin User Guide ===
+
See [[Blueprint-os-user-docs|blueprint]] for details.
  
'''Purpose'''
+
== Deliverables - Application Developers and OpenStack Contributors ==
 
 
* Same format as End User Guide except focus on admin user tasks:
 
:* Manage users and projects
 
:* Create and manage images
 
:* Create and manage flavors
 
:* Migrate servers
 
:* And so on<br />
 
 
 
'''Source  material'''
 
 
 
* [http://www.openstack.org/software/start/ OpenStack API Quick Start]
 
* [http://docs.openstack.org/developer/openstack-projects.html Python Developer Documentation]
 
* [http://docs.openstack.org/developer/language-bindings.html Language Bindings Documentation]
 
* [http://docs.openstack.org/cli/quick-start/content/index.html OpenStack Clients Guide]
 
* [http://docs.openstack.org/run/ OpenStack Administration Guides]
 
* [http://docs.openstack.org/api/api-specs.html OpenStack API Specifications]
 
* [http://docs.openstack.org/api/openstack-compute/programmer/content/ Programming OpenStack Compute API with Shell and Python]
 
* [http://docs.openstack.org/cli/quick-start/content/ OpenStack Clients Guide]
 
 
 
== Deliverables - Application Developers ==
 
  
 
'''Audience:''' Developers who want to extend the OpenStack APIs or write applications by using the OpenStack APIs.<br />
 
'''Audience:''' Developers who want to extend the OpenStack APIs or write applications by using the OpenStack APIs.<br />
Line 167: Line 142:
 
'''Include common glossary?''' Yes<br />
 
'''Include common glossary?''' Yes<br />
  
'''Strategy:''' For the API Reference and the API Specifications, the plan is to use a common set of WADL files to generate the docs. Currently, the API reference page is generated from WADL files, but the API Specifications are not. Then, both sets of docs will be generated from a single set of WADLs, and contributors must update only one set of files.
+
'''Strategy:'''  
<br />
+
# Eliminate the existing API References.
 +
# Add an API Guide that describes API concepts, general information, and ways to access the APIs.
 +
# Move material currently in the API Reference/s into the WADL files to source the API Complete Reference pages. One web page for each OpenStack project. Source code samples from nova code base where possible. <br />
  
=== OpenStack Developer Guide ===
 
  
'''Purpose'''
+
End result: One API Reference page for each project and one API Guide.  
 
+
<br />
* Explain API concepts and provide guidance for developers who want to extend the OpenStack APIs or write applications that run on an OpenStack cloud.<br /><br />
 
 
 
'''Source  material'''
 
 
 
* Python Developer Documentation
 
* Language Bindings Documentation
 
* Continuous Integration (CI) Developer Documentation
 
* Programming OpenStack Compute API with Shell and Python
 
  
=== OpenStack ''project'' API Reference/s ===
 
  
'''Purpose'''
+
'''Blueprint:''' [[Blueprint-os-api-docs|Blueprint - OpenStack API Documentation]]
  
* Provide one reference per project: Compute, Image Service, Identity Service, Object Storage, and Block Storage Service.
+
=== OpenStack API Guide (new) ===
* Explain API concepts and describe API methods and parameters, with examples for each.
 
* Source reference information from WADL files that are shared with the API Reference web page.
 
* Include advanced guidance information.<br /><br />
 
  
'''Source  material'''
+
See [[Blueprint-os-api-docs|blueprint]] for details.
  
* OpenStack ''project'' API Reference/s
+
=== OpenStack ''project'' API Reference/s (delete) ===
  
=== OpenStack API Complete Reference (web page) ===
+
See [[Blueprint-os-api-docs|blueprint]] for details.
  
'''Purpose'''
+
=== OpenStack API Complete Reference (multiple web pages) ===
  
* Provide ''developers'' with a searchable and comprehensive Web page that lists API methods and parameters, with examples for each.  
+
See [[Blueprint-os-api-docs|blueprint]] for details.
* Exclude advanced guidance information (this goes in the ''OpenStack project API Reference/s''), installation instructions, or feature descriptions that are longer than one sentence.<br /><br />
 
  
'''Source  material'''
 
* API Reference - sourced from WADL files
 
  
== Issues ==
 
* Lack of people to implement.
 
----
 
 
[[Category:Spec]]
 
[[Category:Spec]]

Latest revision as of 18:13, 15 May 2014

Warning.svg Old Design Page

This page was used to help design a feature that has been implemented. As a result, this page is unlikely to be updated and could contain outdated information. It was last updated on 2014-05-15

Summary

The OpenStack documentation library was designed a few years ago.

Since then, the library has grown without a specific organization. Also, doc contributors have learned how users interact with it.

This blueprint describes a plan to restructure the OpenStack documentation to:

  • Provide a clear roadmap through the documentation library for different audiences: Deployers, users, and developers.
  • Reduce redundancy.
  • Increase usability, clarity, and consistency.

Audiences

The restructure enables these audiences to complete tasks by using the following docs:

Audience Tasks Docs
OpenStack deployers Install, configure, and run OpenStack clusters.
  • OpenStack Installation Guide
  • OpenStack Operations Guide
  • OpenStack Configuration Reference
  • OpenStack Cloud Administrator Guide
OpenStack end and admin users Perform tasks in an OpenStack cloud through:
  • The Horizon dashboard
  • The OpenStack command-line clients
  • Directly through the OpenStack APIs - see the "OpenStack API Guide"
  • OpenStack End User Guide
  • OpenStack Admin User Guide
OpenStack contributors and application developers Extend the OpenStack APIs.

Write applications that run on top of an OpenStack cloud.

  • OpenStack API Guide
  • OpenStack API Complete Reference web pages - one page for each OpenStack project

Deliverables - Deployers

Audience: Deployers who want to install, configure, and run OpenStack clusters.
Product info: Havana, 2013.1
Include common glossary? Yes

OpenStack Installation Guide

Blueprint:Install-with-multiple-architectures

Purpose

  • Provide step-by-step instructions for deployers about how to install, configure, and run OpenStack clusters.
  • Include easy-to-follow, lightweight, command-by-command steps for installing an OpenStack cluster of defined architecture.
  • Include basic explanatory text for command steps, enabling first time users to understand why they are performing them.
  • Introduce the OpenStack community, including how to get help.
  • Exclude unusual deployment scenarios.

Source material

  • OpenStack Basic Install Guide - Ubuntu 12.04
  • OpenStack Basic Install Guide - Fedora 18
  • OpenStack Install and Deploy Manual - Ubuntu
  • OpenStack Install and Deploy Manual - Red Hat
  • OpenStack <project> Administration Guide/s
  • project devref/s

OpenStack Operations Guide

Purpose

  • Provide opinionated direction for deployers about how to design, set up, and run OpenStack clusters.
  • Include information currently in the OpenStack High Availability Guide.
  • Exclude installation instructions and configuration reference information.

Source material

  • OpenStack Operations Guide
  • OpenStack High Availability Guide?? Or does this stay in its own book?
  • OpenStack project Administration Guide/s
  • project devref/s

OpenStack Configuration Reference

Purpose

  • List configuration options available with OpenStack. Use auto-generation to generate options from the code.
  • Include configuration files, configuration options in each file, configuration extensions, and use cases for each configuration feature.
  • Exclude API parameters.

Source material

  • OpenStack project Administration Guide/s
  • project devref/s

OpenStack Cloud Administrator Guide

Purpose

  • Provide guidance to day-to-day cloud administrators about how to perform administrative tasks.

Source material

  • OpenStack project Administration Guide/s
  • project devref/s


Blueprints: Blueprint - OpenStack Administration Guide, Blueprint - Modularize OpenStack Administration Guide,

Deliverables - Admin and End Users

Audience:

  • Users of OpenStack clouds who perform tasks through the Horizon dashboard or the OpenStack command-line clients.
  • Beginning application developers who want to develop applications on top of OpenStack by using the OpenStack APIs.


Roadmap:

  • Users ramp up on cloud computing by using the Horizon dashboard and the OpenStack command-line clients.
  • Then, they use the OpenStack APIs to create scalable applications.


Product info: Havana, 2013.1

Include common glossary? Yes

Blueprint: Blueprint - OpenStack User Documentation

OpenStack End User Guide (new)

See blueprint for details.

OpenStack Admin User Guide (new)

See blueprint for details.

Deliverables - Application Developers and OpenStack Contributors

Audience: Developers who want to extend the OpenStack APIs or write applications by using the OpenStack APIs.

Release info: API vn

Include common glossary? Yes

Strategy:

  1. Eliminate the existing API References.
  2. Add an API Guide that describes API concepts, general information, and ways to access the APIs.
  3. Move material currently in the API Reference/s into the WADL files to source the API Complete Reference pages. One web page for each OpenStack project. Source code samples from nova code base where possible.


End result: One API Reference page for each project and one API Guide.


Blueprint: Blueprint - OpenStack API Documentation

OpenStack API Guide (new)

See blueprint for details.

OpenStack project API Reference/s (delete)

See blueprint for details.

OpenStack API Complete Reference (multiple web pages)

See blueprint for details.