https://github.com/openstack/venus-specs
A log management component specifications. Mirror of code maintained at opendev.org.
https://github.com/openstack/venus-specs
Last synced: about 1 month ago
JSON representation
A log management component specifications. Mirror of code maintained at opendev.org.
- Host: GitHub
- URL: https://github.com/openstack/venus-specs
- Owner: openstack
- License: apache-2.0
- Created: 2021-10-26T02:28:16.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-03T06:11:54.000Z (over 2 years ago)
- Last Synced: 2025-03-02T18:50:40.434Z (over 1 year ago)
- Language: Python
- Homepage: https://opendev.org/openstack/venus-specs
- Size: 81.1 KB
- Stars: 0
- Watchers: 9
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
========================
Team and repository tags
========================
.. image:: http://governance.openstack.org/tc/badges/venus-specs.svg
:target: http://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
===============================
OpenStack Venus Specifications
===============================
This git repository is used to hold approved design specifications for additions
to the Venus 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//
Where there are two sub-directories:
specs//approved
specifications approved but not yet implemented
specs//implemented
implemented specifications
This directory structure allows you to see what we thought about doing,
decided to do, and actually got done. Users interested in functionality in a
given release should only refer to the ``implemented`` directory.
You can find an example spec in `doc/source/specs/template.rst`.
To track all the blueprints of venus, please refer to the launchpad:
https://blueprints.launchpad.net/openstack-venus
To validate that the specification is syntactically correct (i.e. get more
confidence in the Jenkins 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.