8c038770c1
adds simple specs layout and files to support project blueprint details. Partially Implements: blueprint documentation-update Change-Id: I59fb5aa9a646f0f5a18b78baee45ffd65e62d1d5
36 lines
1.4 KiB
ReStructuredText
36 lines
1.4 KiB
ReStructuredText
OpenStack Akanda Specifications
|
|
===============================
|
|
|
|
This directory structure is used to hold approved design specifications for additions
|
|
to the Akanda 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`. A
|
|
skeleton that contains all the sections required for a spec
|
|
file is located in `specs/skeleton.rst` and can
|
|
be copied, then filled in with the details of a new blueprint for
|
|
convenience.
|
|
|
|
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.
|
|
|
|
Please note, Launchpad blueprints are still used for tracking the
|
|
current status of blueprints. For more information, see::
|
|
|
|
https://wiki.openstack.org/wiki/Blueprints
|
|
http://blueprints.launchpad.net/akanda
|
|
|
|
For more information about working with gerrit, see::
|
|
|
|
http://docs.openstack.org/infra/manual/developers.html#development-workflow
|