OpenStack Baremetal (Ironic) Specifications

Go to file

Devananda van der Veen d6caa9a083 Reorganize specs tree * Move liberty -> approved * Move completed liberty specs to liberty-implemented * Move kilo -> kilo-implemented * Move juno -> juno-implemented * Move kilo-archive -> backlog (moving these to approved causes test failures because the template changed since kilo) * Reword the header for the index page * Update unit tests to look at the new "approved" folder NOTE This patch does not create placeholders in the previous locations for each spec. This will be done in the following patch so that the history is preserved. Both patches must be landed together so that web links are not broken for long. Change-Id: I61f02731150ea944eafaa8c6ea702210364b3478 Implements: blueprint feature-based-releases		2015-08-05 06:57:53 -07:00
doc/source	Reorganize specs tree	2015-08-05 06:57:53 -07:00
specs	Reorganize specs tree	2015-08-05 06:57:53 -07:00
tests	Reorganize specs tree	2015-08-05 06:57:53 -07:00
.gitignore	Initial commit	2014-05-22 15:51:33 -07:00
.gitreview	Updated .gitreview file for repo rename	2014-05-26 16:06:07 +00:00
.testr.conf	Initial commit	2014-05-22 15:51:33 -07:00
LICENSE	Initial commit	2014-05-22 15:51:33 -07:00
README.rst	Reorganize specs tree	2015-08-05 06:57:53 -07:00
requirements.txt	Add RSS feed	2014-09-10 16:00:19 -04:00
setup.cfg	Initial commit	2014-05-22 15:51:33 -07:00
setup.py	Initial commit	2014-05-22 15:51:33 -07:00
tox.ini	Initial commit	2014-05-22 15:51:33 -07:00

README.rst

OpenStack Baremetal Provisioning Specifications

This git repository is used to hold approved design specifications for additions to the Baremetal Provisioning program, and in particular, the Ironic 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/approved/
specs/backlog`/
specs/<cycle>-implemented/

There are also placeholder directories for old links that have been moved.

Specifications must follow the template which can be found at doc/source/specs/template.rst.

Specifications are proposed by adding them to the specs/approved directory and posting it for review. When a spec is fully implemented, it should be moved to specs/<cycle>-implemented. Not all approved blueprints will get fully implemented.

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/ironic

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.