openstack
/
venus-specs
Code Issues Proposed changes
A log management component specifications
56 Commits 1 Branch 0 Tags 216 KiB
Python 100%
Go to file
niuke 5ba67c6c88 Updated links in documentation to be safe links 
Change-Id: I8490be07a09569ac0ec3cacff141bbee54b88c21
 		2023-08-23 16:06:10 +08:00
doc 2023.2Bobcat spec maintain 2023-05-22 16:04:18 +08:00
priorities Fix typo errors 2021-12-25 20:59:15 +08:00
specs 2023.1Antelope spec maintain 2023-05-22 08:56:00 +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 Updated links in documentation to be safe links 2023-08-23 16:06:10 +08: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 Remove invalid config from classifier 2023-03-16 08:10:27 +00: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 Remove invalid conf with releasenote 2023-03-20 02:14:51 +00:00

README.rst

Team and repository tags

image

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.