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: Icc4368708d2f1a11cb976789d8e06496b231302e
|1 month ago|
|doc||1 month ago|
|priorities||5 months ago|
|specs||5 months ago|
|tests||3 months ago|
|.gitignore||1 year ago|
|.gitreview||1 year ago|
|.stestr.conf||1 year ago|
|.zuul.yaml||5 months ago|
|LICENSE||3 years ago|
|README.rst||5 months ago|
|requirements.txt||5 months ago|
|setup.cfg||3 months ago|
|setup.py||3 years ago|
|test-requirements.txt||3 months ago|
|tox.ini||3 months ago|
This git repository is used to hold approved design specifications for additions to the Freezer project. Reviews of the specs are done in gerrit, using a similar workflow to how we review and merge changes to the code itself. For specific policies around specification review, refer to the end of this document.
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
Developers proposing a specification should propose a new file in the
approved directory. freezer-core will review the change in the usual manner for the OpenStack project, and eventually it will get merged if a consensus is reached. At this time the Launchpad blueprint is also approved. The developer is then free to propose code reviews to implement their specification. These reviews should be sure to reference the Launchpad blueprint in their commit message for tracking purposes.
Once all code for the feature is merged into Freezer, the Launchpad blueprint is marked complete. As the developer of an approved specification it is your responsibility to mark your blueprint complete when all of the required patches have merged.
Periodically, someone from freezer-core will move implemented specifications from the
approved directory to the
implemented directory. Whilst individual developers are welcome to propose this move for their implemented specifications, we have generally just done this in a batch at the end of the release cycle. It is important to create redirects when this is done so that existing links to the approved specification are not broken. Redirects aren't symbolic links, they are defined in a file which sphinx consumes. An example is at
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
Additionally, we allow the proposal of specifications that do not have a developer assigned to them. These are proposed for review in the same manner as above, but are added to:
Specifications in this directory indicate the original author has either become unavailable, or has indicated that they are not going to implement the specification. The specifications found here are available as projects for people looking to get involved with Freezer. If you are interested in claiming a spec, start by posting a review for the specification that moves it from this directory to the next active release. Please set yourself as the new primary assignee and maintain the original author in the other contributors list.
Prior to the Juno development cycle, this repository was not used for spec reviews. Reviews prior to Juno were completed entirely through Launchpad blueprints
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://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, the documentation will be available for viewing in HTML format in the
There are a number of review policies which freezer-core will apply when reviewing proposed specifications. They are:
Proposed changes which are trivial (very small amounts of code) and don't change any of our public APIs are sometimes not required to provide a specification. In these cases a Launchpad blueprint is considered sufficient. These proposals are approved during the Open Discussion portion of the weekly Freezer IRC meeting. If you think your proposed feature is trivial and meets these requirements, we recommend you bring it up for discussion there before writing a full specification.
Specifications are only approved for a single release. If your specification was previously approved but not implemented (or not completely implemented), then you must seek re-approval for the specification. You can re-propose your specification by doing the following:
For specifications that depend on code in other OpenStack projects merging we will not approve the Freezer specification until the code in that other project has merged. The best example of this is Cinder and Neutron drivers. To indicate your specification is in this state, please use the Depends-On git commit message tag. The correct format is Depends-On: <change id of other work>. freezer-core can approve the specification at any time, but it wont merge until the code we need to land in the other project has merged as well.