openstack
/
docs-specs
Code Issues Proposed changes

Cleanup README.rst 

Wrap long lines, remove extra whitespace.

Now passes doc8.

Change-Id: If6b31ba87dff9dc7b550b147aa16e3da88c1e057
This commit is contained in:
Andreas Jaeger 2014-08-13 18:13:44 +02:00
parent fd6dcc0531
commit 6c9b1ba135
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.rst
View File

@ -2,26 +2,28 @@
OpenStack Documentation Specifications
======================================
This git repository is used to hold approved design specifications for additions
to the OpenStack Documentation program. Reviews of the specs are done in gerrit, using a
similar workflow to how we review and merge changes to the docs and supporting tools.
This git repository is used to hold approved design specifications for
additions to the OpenStack Documentation program. Reviews of the specs
are done in gerrit, using a similar workflow to how we review and
merge changes to the docs and supporting tools.
The layout of this repository is::
specs/<release>/
You can find an example spec in `doc/source/specs/template.rst`.
You can find an example spec in `doc/source/specs/template.rst`.
Fill it in with the details of a new blueprint for documentation.
For docs, blueprints are required for larger, coordinated projects but not for small
fixes. It's a judgement call for whether you need a spec, so feel free to ask in the
For docs, blueprints are required for larger, coordinated projects but
not for small fixes. It's a judgement call for whether you need a
spec, so feel free to ask in the
#openstack-doc IRC channel or on the openstack-docs mailing list.
To propose a specification for a release-specific doc like the install guides
or the configuration reference, add a new file to the
`specs/<release>` directory and post it for review. The implementation
status of a blueprint for a given release can be found by looking at the
blueprint in Launchpad (and the spec links to Launchpad).
blueprint in Launchpad (and the spec links to Launchpad).
Please realize that not all approved blueprints will get fully implemented.