openstack
/
congress-specs
Code Issues Proposed changes
RETIRED, Congress Design Specifications
98 Commits 1 Branch 0 Tags 1.3 MiB
Go to file
Rui Chen 1f6fc8525e Enable specs sphinx build 
Currently Congress specs sphinx doc build broken,
all of the rst files can't be built into html files,
so previewing the html format of specs is impossible.
Fix it so that we can review specs in human readable way.

Some format issues exist in current rst files, so fix these
at the same time so that tox py27 and docs build can pass.

Change-Id: I0dcdfb315e8314fb54d7333c2395d41ff6a0c9a6
 		2015-08-31 10:53:13 +08:00
doc/source Enable specs sphinx build 2015-08-31 10:53:13 +08:00
specs Enable specs sphinx build 2015-08-31 10:53:13 +08:00
tests Enable specs sphinx build 2015-08-31 10:53:13 +08:00
.gitignore adding all spec files 2014-08-24 17:33:33 -05:00
.gitreview Update .gitreview file to reflect repo rename 2015-04-18 15:17:27 +00:00
.testr.conf adding all spec files 2014-08-24 17:33:33 -05:00
LICENSE adding all spec files 2014-08-24 17:33:33 -05:00
README.rst Workflow documentation is now in infra-manual 2014-12-05 03:30:43 +00:00
requirements.txt Remove docutils pin 2014-08-27 12:40:17 +02:00
setup.cfg adding all spec files 2014-08-24 17:33:33 -05:00
setup.py adding all spec files 2014-08-24 17:33:33 -05:00
tox.ini adding all spec files 2014-08-24 17:33:33 -05:00

README.rst

OpenStack Congress Specifications

This git repository is used to hold approved design specifications for additions to the Congress project. Reviews of the specs are done in gerrit, using a similar workflow to how we review and merge changes to the code itself.

The layout of this repository is:

specs/<release>/

You can find an example spec in doc/source/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 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.

Specifications have to be re-proposed for every release. The review may be 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/congress

Please note, Launchpad blueprints are still used for tracking the current status of blueprints. For more information, see:

https://wiki.openstack.org/wiki/Blueprints

For more information about working with gerrit, see:

http://docs.openstack.org/infra/manual/developers.html#development-workflow

To validate that the specification is syntactically correct (i.e. get more confidence in the Jenkins result), please execute the following command:

$ tox

After running tox, the documentation will be available for viewing in HTML format in the doc/build/ directory.