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.
jiasirui e40fa4fab3 change gerrit remote address 2 months ago
doc Initialize the venus-specs project 12 months ago
priorities change the current title show style 6 months ago
specs Initialize the venus-specs project 12 months ago
.coveragerc Initialize the venus-specs project 12 months ago
.gitignore Initialize the venus-specs project 12 months ago
.gitreview change gerrit remote address 2 months ago
.mailmap Initialize the venus-specs project 12 months ago
.stestr.conf Initialize the venus-specs project 12 months ago
.zuul.yaml .zuul.yaml: add Zuul support to new repo 1 year ago
CONTRIBUTING.rst Initialize the venus-specs project 12 months ago
HACKING.rst Initialize the venus-specs project 12 months ago
LICENSE Initialize the venus-specs project 12 months ago
README.rst Initialize the venus-specs project 12 months ago
setup.cfg setup.cfg: Replace dashes with underscores 7 months ago
setup.py Initialize the venus-specs project 12 months ago
test-requirements.txt Initialize the venus-specs project 12 months ago
tox.ini Replace deprecated UPPER_CONSTRAINTS_FILE variable 6 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 trello board: https://trello.com/b/4nFtHNSg/queens-dev

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.