x/packetary-specs
Code Issues Proposed changes
Specs for packetary project
4 Commits 1 Branch 0 Tags 216 KiB
reStructuredText 62.5%
Python 35.8%
Shell 1.7%
master
Go to file
OpenDev Sysadmins c6b5881b76 OpenDev Migration Patch 
This commit was bulk generated and pushed by the OpenDev sysadmins
as a part of the Git hosting and code review systems migration
detailed in these mailing list posts:

http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html
http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html

Attempts have been made to correct repository namespaces and
hostnames based on simple pattern matching, but it's possible some
were updated incorrectly or missed entirely. Please reach out to us
via the contact information listed at https://opendev.org/ with any
questions you may have.
2019-04-19 19:49:54 +00:00
doc/source Add 0.2.0 spec 2016-06-06 15:40:13 +03:00
specs Add 0.2.0 spec 2016-06-06 15:40:13 +03:00
tests Initial commit 2016-03-18 16:50:12 +03:00
tools Initial commit 2016-03-18 16:50:12 +03:00
.gitignore Initial commit 2016-03-18 16:50:12 +03:00
.gitreview OpenDev Migration Patch 2019-04-19 19:49:54 +00:00
.testr.conf Initial commit 2016-03-18 16:50:12 +03:00
AUTHORS Add 0.2.0 spec 2016-06-06 15:40:13 +03:00
ChangeLog Add 0.2.0 spec 2016-06-06 15:40:13 +03:00
LICENSE Initial commit 2016-03-18 16:50:12 +03:00
README.rst Initial commit 2016-03-18 16:50:12 +03:00
requirements.txt Initial commit 2016-03-18 16:50:12 +03:00
setup.cfg Initial commit 2016-03-18 16:50:12 +03:00
setup.py Initial commit 2016-03-18 16:50:12 +03:00
tox.ini Initial commit 2016-03-18 16:50:12 +03:00

README.rst

Packetary Specifications

This git repository is used to hold approved design specifications for additions to the Packetary 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>/

You can find an example spec in doc/source/specs/template.rst.

Specifications are proposed for a given release by adding them to the specs/<release> directory and posting it for review. The implementation status of a blueprint for a given release can be found by looking at the blueprint in launchpad. Not all approved blueprints will get fully implemented.

Specifications have to be re-proposed for every release. The review may be quick, but even if something was previously approved, it should be re-reviewed to make sure it still makes sense as written.

Please note, Launchpad blueprints are still used for tracking the current status of blueprints. For more information, see:

https://wiki.openstack.org/wiki/Blueprints

For more information about working with gerrit, see:

http://docs.openstack.org/infra/manual/developers.html#development-workflow

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.