A log management component specifications
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
niuke 6e367b9364 remove unicode prefix from code 3 months ago
doc remove unicode prefix from code 3 months ago
priorities Fix typo errors 11 months ago
specs Merge "Create specs directory for Zed" 7 months ago
.coveragerc Initialize the venus-specs project 2 years ago
.gitignore Initialize the venus-specs project 2 years ago
.gitreview change gerrit remote address 1 year ago
.mailmap Initialize the venus-specs project 2 years ago
.stestr.conf Initialize the venus-specs project 2 years ago
.zuul.yaml .zuul.yaml: add Zuul support to new repo 2 years ago
CONTRIBUTING.rst Initialize the venus-specs project 2 years ago
HACKING.rst Initialize the venus-specs project 2 years ago
LICENSE Initialize the venus-specs project 2 years ago
README.rst Fix the doc format of readme.rst 12 months ago
setup.cfg add language support in setup.cfg 11 months ago
setup.py Initialize the venus-specs project 2 years ago
test-requirements.txt Initialize the venus-specs project 2 years ago
tox.ini update pep8 test in tox 7 months ago

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.