openstack/nova-specs
Code Issues Proposed changes

Add readme to docs

Browse Source 
Now that we are publishing the docs from this repo at
http://specs.openstack.org/openstack/nova-specs/ add the README to set
of published documents.

Also cleanup README's rst formatting.

Change-Id: If8bf22bb025611b09269a5e4c1a3e49008f1e713
This commit is contained in:
Joe Gordon
2014-08-07 13:30:10 -07:00
parent 0f4ba96184
commit 13a792c869
3 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.rst
View File

@@ -1,6 +1,10 @@
================================== =======
README
=======
OpenStack Nova Specifications OpenStack Nova Specifications
================================== -----------------------------
This git repository is used to hold approved design specifications for additions This git repository is used to hold approved design specifications for additions
to the Nova project. Reviews of the specs are done in gerrit, using a similar to the Nova project. Reviews of the specs are done in gerrit, using a similar
@@ -10,10 +14,10 @@ The layout of this repository is::
specs/<release>/ specs/<release>/
You can find an example spec in `specs/template.rst`. You can find an example spec in ``specs/template.rst``.
Specifications are proposed for a given release by adding them to the Specifications are proposed for a given release by adding them to the
`specs/<release>` directory and posting it for review. The implementation ``specs/<release>`` directory and posting it for review. The implementation
status of a blueprint for a given release can be found by looking at the status of a blueprint for a given release can be found by looking at the
blueprint in launchpad. Not all approved blueprints will get fully implemented. blueprint in launchpad. Not all approved blueprints will get fully implemented.
@@ -22,19 +26,13 @@ quick, but even if something was previously approved, it should be re-reviewed
to make sure it still makes sense as written. to make sure it still makes sense as written.
Prior to the Juno development cycle, this repository was not used for spec Prior to the Juno development cycle, this repository was not used for spec
reviews. Reviews prior to Juno were completed entirely through Launchpad reviews. Reviews prior to Juno were completed entirely through `Launchpad
blueprints:: blueprints <http://blueprints.launchpad.net/nova>`_
http://blueprints.launchpad.net/nova
Please note, Launchpad blueprints are still used for tracking the Please note, Launchpad blueprints are still used for tracking the
current status of blueprints. For more information, see:: current status of blueprints. For more information, see https://wiki.openstack.org/wiki/Blueprints
https://wiki.openstack.org/wiki/Blueprints For more information about working with gerrit, see https://wiki.openstack.org/wiki/Gerrit_Workflow
For more information about working with gerrit, see::
https://wiki.openstack.org/wiki/Gerrit_Workflow
To validate that the specification is syntactically correct (i.e. get more To validate that the specification is syntactically correct (i.e. get more
confidence in the Jenkins result), please execute the following command:: confidence in the Jenkins result), please execute the following command::

1
doc/source/index.rst
View File

@@ -10,6 +10,7 @@ Contents:
:glob: :glob:
:maxdepth: 1 :maxdepth: 1
readme
specs/* specs/*
Juno approved specs: Juno approved specs:

1
doc/source/readme.rst Normal file
View File

@@ -0,0 +1 @@
.. include:: ../../README.rst