19f7d1b7e1
added the files to explain the spec basics. We will follow using tox as it seems to be too much overhead for little benefit for the volume of spec requests the team is likely to get. Implements blueprint training-guide-spec Change-Id: I7ba685c94b375f1e1ef2f7203034ad2b86c0c748
31 lines
1.2 KiB
ReStructuredText
31 lines
1.2 KiB
ReStructuredText
=========================================
|
|
OpenStack Training Guides Specifications
|
|
=========================================
|
|
|
|
This git repository is used to hold approved design specifications for additions
|
|
to the Training Guides 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/<release>/
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
Approved specs will be created on Launchpad blueprints::
|
|
|
|
http://blueprints.launchpad.net/openstack-training-guides
|
|
|
|
For more information about working with gerrit, see::
|
|
|
|
https://wiki.openstack.org/wiki/Gerrit_Workflow
|