mirror of
https://opendev.org/openstack/ironic-specs.git
synced 2026-01-16 23:01:41 +00:00
OpenStack Baremetal (Ironic) Specifications
3fee396766
This update adds 5.0/ and 5.1/ directories, moves the symlinks for completed specs into them, and updates the index.html page to reflect the completion of the Mitaka cycle. It also moves te partition-image-support-for-agent-driver from the backlog to the approved directory, since the work was actually completed, and updates the spec to include two missing (and unaffected) sections. Change-Id: Ice187410798a4d93044095dd476792d919222701 |
||
|---|---|---|
| doc/source | ||
| priorities | ||
| specs | ||
| tests | ||
| .gitignore | ||
| .gitreview | ||
| .testr.conf | ||
| LICENSE | ||
| README.rst | ||
| requirements.txt | ||
| setup.cfg | ||
| setup.py | ||
| test-requirements.txt | ||
| tox.ini | ||
=============================================== 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. Also starting with the Mitaka development cycle, our Launchpad bug tracking system is used for tracking the work related to a specification. (This replaces the use of Launchpad blueprints). The bug should be tagged with 'rfe', its title should be prefixed with '[RFE]' and the Importance should be set to 'Wishlist'. For existing RFE bugs, see:: https://bugs.launchpad.net/ironic/+bugs?field.tag=rfe 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 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.