Solum Design Specifications
Go to file
Andreas Jaeger 71013aed21 Cleanup py27 support
Make a few cleanups:
- Remove obsolete sections from setup.cfg
- Switch to using sphinx-build
- Switch to openstackdocstheme, update requirements for this
- Cleanup doc/source/conf.py to remove now obsolete content.
- Remove install_command from tox.ini, the default is fine

Change-Id: If26e126d88b33cd45a72932d1b271f7f08d50652
2020-04-10 11:48:06 +02:00
doc/source Cleanup py27 support 2020-04-10 11:48:06 +02: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 OpenDev Migration Patch 2019-04-19 19:34:05 +00:00
.testr.conf Init spec files for testing/templates... 2014-06-17 14:46:58 +02:00
.zuul.yaml import zuul job settings from project-config 2018-08-17 17:01:12 +09: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 Cleanup py27 support 2020-04-10 11:48:06 +02:00
setup.cfg Cleanup py27 support 2020-04-10 11:48:06 +02:00
setup.py Init spec files for testing/templates... 2014-06-17 14:46:58 +02:00
tox.ini Cleanup py27 support 2020-04-10 11:48:06 +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.