db259bfc1b
This uses the doc8 style checker to check that the documents conform to certain requirements, as documented at https://pypi.python.org/pypi/doc8. In particular, we no longer need to check for these in our test code since they are checked via doc8: - lines don't exceed 79 chars - there are no trailing spaces - there are no carriage returns Some existing specs were modified because they had tabs or no newlines at the end of the file. Change-Id: If27281c7efd60c9f15ca07c723dd94a7d086c325
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/ironicPlease note, Launchpad blueprints are still used for tracking the current status of blueprints. For more information, see:
https://wiki.openstack.org/wiki/BlueprintsFor more information about working with gerrit, see:
http://docs.openstack.org/infra/manual/developers.html#development-workflowTo validate that the specification is syntactically correct (i.e. get more confidence in the Jenkins result), please execute the following command:
$ toxAfter running tox, the documentation will be available
for viewing in HTML format in the doc/build/ directory.