openstack
/
solum-specs
Code Issues Proposed changes
RETIRED, Solum Design Specifications
24 Commits 1 Branch 0 Tags 659 KiB
Go to file
Flavio Percoco 1d81653eab Show team and repo badges on README 
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

b'https://gist.github.com/bb0141bee13ca29511d1fc95a6f15bb4\n'

Change-Id: I58273099e38fa56a2b173c58cf9b2ca018eba002
 		2016-11-25 12:36:57 +01:00
doc/source App resource 2015-05-19 12:13:53 -05:00
specs Spec for deployer plugins 2015-08-19 12:54:43 -05:00
tests Init spec files for testing/templates... 2014-06-17 14:46:58 +02:00
.gitignore Init spec files for testing/templates... 2014-06-17 14:46:58 +02:00
.gitreview Update .gitreview for project rename 2015-09-11 20:58:43 +00:00
.testr.conf Init spec files for testing/templates... 2014-06-17 14:46:58 +02:00
LICENSE Initial commit 2014-06-05 12:03:31 -07:00
README.rst Show team and repo badges on README 2016-11-25 12:36:57 +01:00
requirements.txt Remove docutils pin 2014-08-27 12:41:00 +02:00
setup.cfg Init spec files for testing/templates... 2014-06-17 14:46:58 +02:00
setup.py Init spec files for testing/templates... 2014-06-17 14:46:58 +02:00
tox.ini Init spec files for testing/templates... 2014-06-17 14:46:58 +02:00

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.