Switch to openstackdocstheme 2.2.1 version. Using this version will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. Disable openstackdocs_auto_name to use 'project' variable as name. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: I132d4efb3955ba3425426a4bb617dc5cd0d86944
|6 months ago|
|doc/source||6 months ago|
|specs||7 months ago|
|tests||6 years ago|
|.gitignore||6 years ago|
|.gitreview||1 year ago|
|.testr.conf||6 years ago|
|.zuul.yaml||2 years ago|
|LICENSE||6 years ago|
|README.rst||4 years ago|
|requirements.txt||6 months ago|
|setup.cfg||7 months ago|
|setup.py||3 years ago|
|tox.ini||7 months ago|
This git repository is used to hold approved design specifications for additions to the Murano 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:
Where there are two sub-directories:
specs/<release>/approved: specifications approved but not yet implemented specs/<release>/implemented: implemented specifications
This directory structure allows you to see what we thought about doing, decided to do, and actually got done. Users interested in functionality in a given release should only refer to the
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 Kilo development cycle this repository was not used for spec reviews. Reviews prior to Juno were completed entirely through Launchpad blueprints:
Starting from the Kilo-1 developement milestone Murano performs the pilot of the specs repos approach.
Please note, Launchpad blueprints are still used for tracking the current status of blueprints. For more information, see:
For more information about working with gerrit, see:
To validate that the specification is syntactically correct (i.e. get more confidence in the Jenkins result), please execute the following command:
tox, the documentation will be available for viewing in HTML format in the