openstack
/
solum-specs
Code Issues Proposed changes
Solum Design Specifications
17 Commits 1 Branch 0 Tags 652 KiB
reStructuredText 94.4%
Python 5.6%
Go to file
Andreas Jaeger d11fbcf0b2 Stop using intersphinx 
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)

This also removes the requirement for internet access during docs build.

This can cause docs jobs to fail if the project errors out on
warnings.

Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
 		2014-09-13 09:54:30 +02:00
doc/source Stop using intersphinx 2014-09-13 09:54:30 +02:00
specs Merge "Custom language packs" 2014-09-03 15:16:44 +00: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 Init spec files for testing/templates... 2014-06-17 14:46:58 +02: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 Init spec files for testing/templates... 2014-06-17 14:46:58 +02: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

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:

https://wiki.openstack.org/wiki/Gerrit_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.