A log management component specifications

Go to file

Zuul 4b7cc3bf09 Merge "Add Antelope dir for venus-specs"		2023-03-18 06:53:40 +00:00
doc	remove unicode prefix from code	2022-08-24 19:36:20 +08:00
priorities	Fix typo errors	2021-12-25 20:59:15 +08:00
specs	Merge "Add Antelope dir for venus-specs"	2023-03-18 06:53:40 +00:00
.coveragerc	Initialize the venus-specs project	2020-12-25 14:58:35 +08:00
.gitignore	Initialize the venus-specs project	2020-12-25 14:58:35 +08:00
.gitreview	change gerrit remote address	2021-10-20 14:55:56 +08:00
.mailmap	Initialize the venus-specs project	2020-12-25 14:58:35 +08:00
.stestr.conf	Initialize the venus-specs project	2020-12-25 14:58:35 +08:00
.zuul.yaml	.zuul.yaml: add Zuul support to new repo	2020-11-13 00:48:38 +00:00
CONTRIBUTING.rst	Add reference for venus contribution guide	2023-03-16 08:17:01 +00:00
HACKING.rst	Initialize the venus-specs project	2020-12-25 14:58:35 +08:00
LICENSE	Initialize the venus-specs project	2020-12-25 14:58:35 +08:00
README.rst	Fix the doc format of readme.rst	2021-12-22 18:43:20 +08:00
setup.cfg	add language support in setup.cfg	2021-12-28 14:17:45 +08:00
setup.py	Initialize the venus-specs project	2020-12-25 14:58:35 +08:00
test-requirements.txt	Initialize the venus-specs project	2020-12-25 14:58:35 +08:00
tox.ini	update pep8 test in tox	2022-05-18 17:11:49 +08:00

README.rst

Team and repository tags

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/<release>/

Where there are two sub-directories:

specs/<release>/approved

specifications approved but not yet implemented

specs/<release>/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.