Vendor-facing API for registration of interop-compliance
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Goutham Pacha Ravi 78c4ce8ac8 Fix broken links and redirects 6 months ago
mitaka/implemented Fix specs format to improve rendered documentation 5 years ago
newton/implemented Fix broken links and redirects 5 months ago
ocata/implemented Rename to 2 years ago
pike/approved Fix broken links and redirects 5 months ago
prior Fix broken links and redirects 5 months ago
queens/approved Fix broken links and redirects 5 months ago
README.rst Re-organize the RefStack specs directory. 6 years ago
template.rst Fix broken links and redirects 5 months ago


Refstack Specifications

This folder is used to hold design specifications for additions to the RefStack 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 folder is as follows:


The lifecycle of a specification

Specifications are proposed by adding an .rst file to the specs/<release>/approved directory and posting it for review. You can find an example specification in /specs/template.rst.

Once a specification has been fully implemented, meaning a patch has landed, it will be moved to the implemented directory and the corresponding blueprint will be marked as complete.

Specifications are only approved for a single release. If a specification was previously approved but not implemented (or not completely implemented), then the specification needs to be re-proposed by copying (not move) it to the right directory for the current release.

Previously approved specifications

The RefStack specs directory was re-structured during the Mitaka cycle. Therefore, the specs approved and implemented prior to the Mitaka cycle will be saved in the specs/prior/ directories.


Please note, Launchpad blueprints are still used for tracking the status of the 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