openstack
/
ironic-specs
Code Issues Proposed changes
OpenStack Baremetal (Ironic) Specifications
300 Commits 1 Branch 0 Tags 20 MiB
Python 100%
Go to file
Ruby Loo 1b303b8142 Don't move specs from approved directory 
When specs are approved but not yet implemented, they reside in
specs/approved. After implementation, we have been moving them to
specs/<release>-implemented. Which means that any links to specs
in specs/approved are broken.

This patch leaves the specs in specs/approved, and adds a new
specs/not-implemented directory that contains soft links to all the
approved-but-not-yet-implemented specs that reside in specs/approved.
For specs that were implemented, e.g. in release 4.3, a specs/4.3
directory is created with soft links to the implemented specs (that still
reside in specs/approved).

Since we are using links to files, the specs cannot have labels
because sphinx warns of duplicate labels.

Change-Id: Icd81d68cec4bbfaa3b20e370ba1b31edb32ae1d1
 		2015-12-16 22:16:02 +00:00
doc/source Don't move specs from approved directory 2015-12-16 22:16:02 +00:00
priorities Add Mitaka project priorities 2015-11-03 09:43:29 -08:00
specs Don't move specs from approved directory 2015-12-16 22:16:02 +00:00
tests Use launchpad bugs instead of blueprints 2015-12-10 12:27:22 +01: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 Don't move specs from approved directory 2015-12-16 22:16:02 +00: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
test-requirements.txt Use doc8 style checker 2015-09-30 20:29:50 +00:00
tox.ini Use doc8 style checker 2015-09-30 20:29:50 +00: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/not-implemented/
specs/<release>/
specs/<juno|kilo|liberty>-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, adding a soft link to it from the specs/not-implemented directory, and posting it for review. When a specification is fully implemented, the link in specs/not-implemented directory should be moved to the appropriate specs/<release> directory. Not all approved specifications will get fully implemented.

Starting with the Mitaka development cycle, all approved specifications (implemented and not-implemented) will reside in the specs/approved directory.

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.