Add readme to docs
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:
parent
0f4ba96184
commit
13a792c869
26
README.rst
26
README.rst
|
@ -1,6 +1,10 @@
|
|||
==================================
|
||||
=======
|
||||
README
|
||||
=======
|
||||
|
||||
OpenStack Nova Specifications
|
||||
==================================
|
||||
-----------------------------
|
||||
|
||||
|
||||
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
|
||||
|
@ -10,10 +14,10 @@ The layout of this repository is::
|
|||
|
||||
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
|
||||
`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
|
||||
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.
|
||||
|
||||
Prior to the Juno development cycle, this repository was not used for spec
|
||||
reviews. Reviews prior to Juno were completed entirely through Launchpad
|
||||
blueprints::
|
||||
|
||||
http://blueprints.launchpad.net/nova
|
||||
reviews. Reviews prior to Juno were completed entirely through `Launchpad
|
||||
blueprints <http://blueprints.launchpad.net/nova>`_
|
||||
|
||||
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
|
||||
confidence in the Jenkins result), please execute the following command::
|
||||
|
|
|
@ -10,6 +10,7 @@ Contents:
|
|||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
readme
|
||||
specs/*
|
||||
|
||||
Juno approved specs:
|
||||
|
|
|
@ -0,0 +1 @@
|
|||
.. include:: ../../README.rst
|
Loading…
Reference in New Issue