Merge "Fix issues found by doc8"

This commit is contained in:
Jenkins 2014-08-17 04:58:25 +00:00 committed by Gerrit Code Review
commit 3ee22f1e8e
8 changed files with 24 additions and 3 deletions

View File

@ -7,6 +7,7 @@ review up on review.openstack.org.
May 20, 2014 May 20, 2014
To do tasks: To do tasks:
- Add a chapter describing monitoring; deeper dive into Telemetry (ceilomter) - Add a chapter describing monitoring; deeper dive into Telemetry (ceilomter)
- Update networking information with the goal of starting a new - Update networking information with the goal of starting a new
Network Admin Guide* Network Admin Guide*
@ -14,6 +15,7 @@ To do tasks:
- Add audience information; who is this book intended for - Add audience information; who is this book intended for
Ongoing tasks: Ongoing tasks:
- Ensure it meets conventions and standards - Ensure it meets conventions and standards
- Continually update with latest OpenStack dashboard (horizon) - Continually update with latest OpenStack dashboard (horizon)
information including great descriptions of fields and why you set a information including great descriptions of fields and why you set a
@ -21,6 +23,7 @@ Ongoing tasks:
- Continually add Python examples to SDK chapter - Continually add Python examples to SDK chapter
Wishlist tasks: Wishlist tasks:
- Replace all individual client commands (like keystone, nova) with - Replace all individual client commands (like keystone, nova) with
openstack client commands openstack client commands

View File

@ -7,14 +7,17 @@ review up on review.openstack.org.
May 20, 2014 May 20, 2014
To do tasks: To do tasks:
- Add a common OpenStack Client reference chapter - Add a common OpenStack Client reference chapter
- Add audience information; who is this book intended for - Add audience information; who is this book intended for
Ongoing tasks: Ongoing tasks:
- Ensure it meets conventions and standards - Ensure it meets conventions and standards
- Continually add CLI commands for integrated projects; but only when - Continually add CLI commands for integrated projects; but only when
the release occurs the release occurs
Wishlist tasks: Wishlist tasks:
- Add troubleshooting for clients - installation, environment - Add troubleshooting for clients - installation, environment
variables. Can be common. variables. Can be common.

View File

@ -7,6 +7,7 @@ review up on review.openstack.org.
May 20, 2014 May 20, 2014
To do tasks: To do tasks:
- Add a chapter showing differences from release-to-release of renamed - Add a chapter showing differences from release-to-release of renamed
and removed options and removed options
- Add descriptions that describe why you would set a setting - Add descriptions that describe why you would set a setting
@ -14,10 +15,12 @@ To do tasks:
- Add audience information; who is this book intended for - Add audience information; who is this book intended for
Ongoing tasks: Ongoing tasks:
- Ensure it meets conventions and standards - Ensure it meets conventions and standards
- Continually update with latest reference information including great - Continually update with latest reference information including great
descriptions of options and why you set a setting or groups of descriptions of options and why you set a setting or groups of
settings settings
Wishlist tasks: Wishlist tasks:
- Can distros like Ubuntu produce documented config files? - Can distros like Ubuntu produce documented config files?

View File

@ -383,7 +383,7 @@ For example:
constraints: constraints:
- custom_constraint: nova.keypair - custom_constraint: nova.keypair
.. _hot_spec_pseudo_parameters .. _hot_spec_pseudo_parameters:
Pseudo Parameters Pseudo Parameters
----------------- -----------------
@ -729,7 +729,7 @@ template is given as single parameter to the get_resource function.
list_join list_join
-------- ---------
The *list_join* function joins a list of strings with the given delimiter. The *list_join* function joins a list of strings with the given delimiter.
The syntax of the list_join function is as follows: The syntax of the list_join function is as follows:

View File

@ -7,13 +7,16 @@ review up on review.openstack.org.
May 21, 2014 May 21, 2014
To do tasks: To do tasks:
- Add a chapter describing how to make an image for Database as a - Add a chapter describing how to make an image for Database as a
Service (trove) Service (trove)
- Add audience information; who is this book intended for - Add audience information; who is this book intended for
Ongoing tasks: Ongoing tasks:
- Ensure it meets conventions and standards - Ensure it meets conventions and standards
Wishlist tasks: Wishlist tasks:
- Replace all individual client commands (like keystone, glance) with - Replace all individual client commands (like keystone, glance) with
openstack client commands openstack client commands

View File

@ -11,6 +11,7 @@ This guide has an overall blueprint with spec at:
https://wiki.openstack.org/wiki/Documentation/InstallationGuideImprovements https://wiki.openstack.org/wiki/Documentation/InstallationGuideImprovements
To do tasks: To do tasks:
- Remove openstack-config (crudini) commands; standardize manual install - Remove openstack-config (crudini) commands; standardize manual install
- Unify chapter and section names (such as Overview) - Unify chapter and section names (such as Overview)
- Add sample output of each command and highlight important parts - Add sample output of each command and highlight important parts
@ -23,9 +24,11 @@ To do tasks:
- Add audience information; who is this book intended for - Add audience information; who is this book intended for
Ongoing tasks: Ongoing tasks:
- Ensure it meets conventions and standards - Ensure it meets conventions and standards
- Continually update with latest release information relevant to install - Continually update with latest release information relevant to install
Wishlist tasks: Wishlist tasks:
- Replace all individual client commands (like keystone, nova) with - Replace all individual client commands (like keystone, nova) with
openstack client commands openstack client commands

View File

@ -1,5 +1,5 @@
Roadmap for Admin User Guide Roadmap for Admin User Guide
-------------------------- ----------------------------
This file is stored with the source to offer ideas for what to work on. This file is stored with the source to offer ideas for what to work on.
Put your name next to a task if you want to work on it and put a WIP Put your name next to a task if you want to work on it and put a WIP
@ -7,15 +7,18 @@ review up on review.openstack.org.
May 20, 2014 May 20, 2014
To do tasks: To do tasks:
- Add a chapter describing Telemetry tasks (ceilometer); how to monitor usage - Add a chapter describing Telemetry tasks (ceilometer); how to monitor usage
Ongoing tasks: Ongoing tasks:
- Ensure it meets conventions and standards - Ensure it meets conventions and standards
- Continually update with latest OpenStack dashboard (horizon) - Continually update with latest OpenStack dashboard (horizon)
information including great descriptions of fields and why you set a information including great descriptions of fields and why you set a
setting setting
Wishlist tasks: Wishlist tasks:
- Get examples of common tasks from real admins and add to this guide - Get examples of common tasks from real admins and add to this guide
as how-to: migration of VM from one host to another, quota as how-to: migration of VM from one host to another, quota
management, targeting launch on a particular compute node management, targeting launch on a particular compute node

View File

@ -7,11 +7,13 @@ review up on review.openstack.org.
May 20, 2014 May 20, 2014
To do tasks: To do tasks:
- Add a chapter describing the HOT templates for Orchestration, how to use them - Add a chapter describing the HOT templates for Orchestration, how to use them
- Add reference information about HOT templates for Orchestration; - Add reference information about HOT templates for Orchestration;
attempt to automate attempt to automate
Ongoing tasks: Ongoing tasks:
- Ensure it meets conventions and standards - Ensure it meets conventions and standards
- Continually update with latest OpenStack dashboard (horizon) - Continually update with latest OpenStack dashboard (horizon)
information including great descriptions of fields and why you set a information including great descriptions of fields and why you set a
@ -19,6 +21,7 @@ Ongoing tasks:
- Continually add Python examples to SDK chapter - Continually add Python examples to SDK chapter
Wishlist tasks: Wishlist tasks:
- Investigate moving to simpler markup and still enabling translation - Investigate moving to simpler markup and still enabling translation
- Replace all individual client commands (like keystone, nova) with - Replace all individual client commands (like keystone, nova) with
openstack client commands openstack client commands