RETIRED, OpenStack Chef Blueprint specs
Go to file
Flavio Percoco d32a5a10d5 Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

https://gist.github.com/797e9719287a915ff18e6af10eb8b54f

Change-Id: Idbaa575cd45c6152bb9e1049b567157aa0ad3692
2016-11-25 17:12:20 +01:00
doc refactored for switch to specs.openstack.org 2015-08-04 11:54:01 +02:00
specs add spec for refactoring configuration templates 2015-09-24 20:25:16 +02:00
.gitignore Filling in the initial layout for the repo. 2014-07-25 12:13:09 -05:00
.gitreview Update .gitreview file for project rename 2015-06-12 23:12:30 +00:00
CONTRIBUTING.rst refactored for switch to specs.openstack.org 2015-08-04 11:54:01 +02:00
HACKING.rst refactored for switch to specs.openstack.org 2015-08-04 11:54:01 +02:00
LICENSE refactored for switch to specs.openstack.org 2015-08-04 11:54:01 +02:00
MAINTAINERS.md Updates the MAINTAINERS.md with current cores 2016-08-17 13:34:19 -07:00
README.rst Show team and repo badges on README 2016-11-25 17:12:20 +01:00
requirements.txt Filling in the initial layout for the repo. 2014-07-25 12:13:09 -05:00
setup.cfg Changed the home-page link for openstack-chef-specs 2016-10-24 18:02:00 +05:30
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

Team and repository tags

image

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:

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.