openstack
/
venus-specs
Code Issues Proposed changes
A log management component specifications
3 Commits 1 Branch 0 Tags 216 KiB
Python 100%
Go to file
jiasirui 85954e9f55 Initialize the venus-specs project 
Change-Id: I788a3c0a4ec29deaeb8a73ce061aaa9dbd06e0b2
 		2020-12-25 14:58:35 +08:00
doc Initialize the venus-specs project 2020-12-25 14:58:35 +08:00
specs Initialize the venus-specs project 2020-12-25 14:58:35 +08: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 Added .gitreview 2020-11-12 08:17:42 +00: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 Initialize the venus-specs project 2020-12-25 14:58:35 +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 Initialize the venus-specs project 2020-12-25 14:58:35 +08:00
setup.cfg Initialize the venus-specs project 2020-12-25 14:58:35 +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 Initialize the venus-specs project 2020-12-25 14:58:35 +08: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 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.