Solum Design 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.
OpenDev Sysadmins b9ac8a397e OpenDev Migration Patch 1 month ago
doc/source Removes unnecessary utf-8 coding for solum-specs 2 years ago
specs Spec for deployer plugins 3 years ago
tests Init spec files for testing/templates... 5 years ago
.gitignore Init spec files for testing/templates... 5 years ago
.gitreview OpenDev Migration Patch 1 month ago
.testr.conf Init spec files for testing/templates... 5 years ago
.zuul.yaml import zuul job settings from project-config 9 months ago
LICENSE Initial commit 5 years ago
README.rst Show team and repo badges on README 2 years ago
requirements.txt Remove docutils pin 4 years ago
setup.cfg Change openstack-dev to openstack-discuss 5 months ago
setup.py Init spec files for testing/templates... 5 years ago
tox.ini fix tox python3 overrides 8 months ago

README.rst

Team and repository tags

image

OpenStack Solum Specifications

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

Prior to the Juno development cycle, this repository was not used for spec reviews. Reviews prior to Juno were completed entirely through Launchpad blueprints:

http://blueprints.launchpad.net/solum

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.