Difference between revisions of "Blueprint-restructure-documentation"

Latest revision as of 18:13, 15 May 2014

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

Launchpad Entry: restructure-documentation
Created: Tom Fifield
Contributors: Diane Fleming

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:

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.

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.

@@ Line 1: / Line 1: @@
+{{ImplementedFeature}}
 * '''Launchpad Entry''':  [https://blueprints.launchpad.net/openstack-manuals/+spec/restructure-documentation restructure-documentation]
 * '''Created''': Tom Fifield
@@ Line 21: / Line 21: @@
 ! Audience !! Tasks !! Docs
 |-
-| OpenStack cloud deployers || Install, configure, and run OpenStack clusters.
+| OpenStack deployers || Install, configure, and run OpenStack clusters.
 ||
 * ''OpenStack Installation Guide''
 * ''OpenStack Operations Guide''
 * ''OpenStack Configuration Reference''
+* ''OpenStack Cloud Administrator Guide''
 |-
-|  OpenStack cloud users || Perform tasks in an OpenStack cloud through:
+|  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
+* 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 or write applications that run on top of an OpenStack cloud.
+| OpenStack contributors and application developers || Extend the OpenStack APIs.<br />
+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 49: / Line 50: @@
 === OpenStack Installation Guide ===
+Blueprint:[[Install-with-multiple-architectures]]
-==== Purpose ====
+'''Purpose'''
 * Provide step-by-step instructions for ''deployers'' about how to install, configure, and run OpenStack clusters.
@@ Line 56: / Line 58: @@
 * 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.
+* Exclude unusual deployment scenarios.<br /><br />
-==== Source  material ====
+'''Source  material'''
 * OpenStack Basic Install Guide - Ubuntu 12.04
@@ Line 65: / Line 67: @@
 * OpenStack Install and Deploy Manual - Red Hat
 * OpenStack <project> Administration Guide/s
-* <project> devref/s
+* ''project'' devref/s
 === OpenStack Operations Guide ===
-==== Purpose ====
+'''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.
+* Exclude installation instructions and configuration reference information.<br /><br />
-==== Source material ====
+'''Source  material'''
 * OpenStack Operations Guide
-* OpenStack High Availability Guide
+* OpenStack High Availability Guide?? Or does this stay in its own book?
-* OpenStack <project> Administration Guide/s
+* OpenStack ''project'' Administration Guide/s
-* <project> devref/s
+* ''project'' devref/s
 === OpenStack Configuration Reference ===
-==== Purpose ====
+'''Purpose'''
-* List configuration options available with OpenStack.
+* 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.
+* Exclude API parameters.<br /><br />
-==== Source material ====
+'''Source  material'''
 * 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 - Users ==
+== Deliverables - Admin and End Users  ==
 '''Audience''':
 * Users of OpenStack clouds who perform tasks through the Horizon dashboard or the OpenStack command-line clients.
-* Developers who 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 />
 '''Roadmap''':
@@ Line 103: / Line 120: @@
 * Then, they use the OpenStack APIs to create scalable applications.
 <br />
+'''Product info:''' Havana, 2013.1<br />
+'''Include common glossary?''' Yes <br />
-=== OpenStack User Guide ===
+'''Blueprint:''' [[Blueprint-os-user-docs|Blueprint - OpenStack User Documentation]]
-==== Purpose ====
+=== OpenStack End User Guide (new) ===
-* Explain OpenStack cloud concepts and describe how to use an OpenStack cloud.
+See [[Blueprint-os-user-docs|blueprint]] for details.
-* Include command-line tools and credentials, how to use Horizon dashboard, and how to create images.
-* Exclude Cloud application architecture.
-==== Source material ====
+=== OpenStack Admin User Guide (new) ===
-* OpenStack API Quick Start
+See [[Blueprint-os-user-docs|blueprint]] for details.
-* Python Developer Documentation
-* Language Bindings Documentation
-* OpenStack Clients Guide
-* <''project''> devref/s
-=== OpenStack Command Reference ===
+== Deliverables - Application Developers and OpenStack Contributors ==
-==== Purpose ====
+'''Audience:''' Developers who want to extend the OpenStack APIs or write applications by using the OpenStack APIs.<br />
-* Describe command-line clients and their subcommands and required and optional parameters.
+'''Release info:''' API v''n''<br />
-* Exclude concepts (these go in the ''OpenStack User Guide'') or installation instructions (these go in the ''OpenStack Installation Guide'').
-==== Source material ====
+'''Include common glossary?''' Yes<br />
-* OpenStack Clients Guide
+'''Strategy:'''
+# 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 />
-== Deliverables - Developers ==
-'''Audience:''' Developers who want to extend the OpenStack APIs or write applications by using the OpenStack APIs.<br />
+End result: One API Reference page for each project and one API Guide.
-'''Release info:''' API v''n''<br />
+<br />
-'''Include common glossary?''' Yes<br />
-=== OpenStack ''project'' API Specification ===
+'''Blueprint:''' [[Blueprint-os-api-docs|Blueprint - OpenStack API Documentation]]
-==== Purpose ====
+=== OpenStack API Guide (new) ===
-* Explain API concepts and describe API methods and parameters, with examples for each.
+See [[Blueprint-os-api-docs|blueprint]] for details.
-* Include advanced guidance information.
-==== Source material ====
+=== OpenStack ''project'' API Reference/s (delete) ===
-* OpenStack ''project'' API Specification/s
+See [[Blueprint-os-api-docs|blueprint]] for details.
-=== OpenStack API Reference (web page) ===
+=== OpenStack API Complete Reference (multiple web pages) ===
-==== Purpose ====
-* Provide ''developers'' with a searchable and comprehensive Web page that lists API methods and parameters, with examples for each.
-* Exclude advanced guidance information (this goes in the ''OpenStack <project> API Specification/s''), installation instructions, or feature descriptions that are longer than one sentence.
-==== Source material ====
+See [[Blueprint-os-api-docs|blueprint]] for details.
-* API Complete Reference - sourced from WADL files
-== Issues ==
-* Lack of people to implement.
-----
 [[Category:Spec]]

Difference between revisions of "Blueprint-restructure-documentation"

Latest revision as of 18:13, 15 May 2014

Contents

Summary

Audiences

Deliverables - Deployers

OpenStack Installation Guide

OpenStack Operations Guide

OpenStack Configuration Reference

OpenStack Cloud Administrator Guide

Deliverables - Admin and End Users

OpenStack End User Guide (new)

OpenStack Admin User Guide (new)

Deliverables - Application Developers and OpenStack Contributors

OpenStack API Guide (new)

OpenStack project API Reference/s (delete)

OpenStack API Complete Reference (multiple web pages)