RETIRED, OpenStack Chef Blueprint specs
Go to file
Jenkins e9041ae375 Merge "Update Chef gem to version 11.16" 2014-09-29 01:36:07 +00:00
doc/source This is the inital cookbook versioning doc 2014-08-15 09:39:31 -05:00
specs Merge "Update Chef gem to version 11.16" 2014-09-29 01:36:07 +00:00
.gitignore Filling in the initial layout for the repo. 2014-07-25 12:13:09 -05:00
.gitreview Added .gitreview 2014-07-22 09:36:20 +00:00
README.rst This is the inital cookbook versioning doc 2014-08-15 09:39:31 -05:00
requirements.txt Filling in the initial layout for the repo. 2014-07-25 12:13:09 -05:00
setup.cfg Filling in the initial layout for the repo. 2014-07-25 12:13:09 -05:00
setup.py Filling in the initial layout for the repo. 2014-07-25 12:13:09 -05:00
tox.ini Filling in the initial layout for the repo. 2014-07-25 12:13:09 -05:00

README.rst

OpenStack-chef Specifications

This git repository is used to hold approved design specifications for additions to the openstack-chef project. Reviews of the specifications 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>/<cookbook>/

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 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. Use the Common cookbook directory for specifications that effect multiple cookbooks. Once the specification is approved and merged, the LaunchPad blueprint will be updated accordingly.

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/openstack-chef

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:

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:

$ tox

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