https://github.com/openstack/tacker-specs
NFV Orchestration (Tacker) Specifications. Mirror of code maintained at opendev.org.
https://github.com/openstack/tacker-specs
Last synced: about 1 year ago
JSON representation
NFV Orchestration (Tacker) Specifications. Mirror of code maintained at opendev.org.
- Host: GitHub
- URL: https://github.com/openstack/tacker-specs
- Owner: openstack
- License: other
- Created: 2014-06-27T01:12:14.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2025-02-03T05:17:09.000Z (over 1 year ago)
- Last Synced: 2025-07-03T03:03:59.461Z (about 1 year ago)
- Language: Python
- Homepage: https://opendev.org/openstack/tacker-specs
- Size: 14.8 MB
- Stars: 37
- Watchers: 7
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
========================
Team and repository tags
========================
.. image:: https://governance.openstack.org/tc/badges/tacker-specs.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
===============================
OpenStack Tacker Specifications
===============================
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//
You can find an example spec in `specs/template.rst`.
Specifications are proposed for a given release by adding them to the
`specs/` 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.