This git repository is used to hold approved design specifications for additions to the Tacker 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.
Please note, Launchpad blueprints are still used for tracking the current status of blueprints. For more information, see:
https://wiki.openstack.org/wiki/Blueprints
Launchpad blueprints for Tacker can be found at:
https://blueprints.launchpad.net/tacker
For more information about working with gerrit, see:
https://docs.openstack.org/infra/manual/developers.html#development-workflow
To validate that the specification is syntactically correct (i.e. get more confidence in the Zuul 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. Please do not checkin the generated
HTML files as a part of your commit.
Note that even if a syntax error occurs in mermaid, it will not be an
error in tox.
When using mermaid to create diagrams, you need to carefully check the
built html file.