Migrate to opendev.org
Change-Id: Ia9eeeea3fc94c23a5947b5e9606106bd252f60ed Signed-off-by: Trinh Nguyen <email@example.com>
|1 month ago|
|doc||2 months ago|
|images||3 years ago|
|specs||1 month ago|
|.gitignore||3 years ago|
|.gitreview||1 month ago|
|.testr.conf||3 years ago|
|.zuul.yaml||6 months ago|
|LICENSE||3 years ago|
|README.rst||8 months ago|
|setup.cfg||5 months ago|
|setup.py||3 years ago|
|test-requirements.txt||8 months ago|
|tox.ini||7 months ago|
Please read the Searchlight process documentation on feature requests and bug reports:
This git repository is used to hold approved design specifications for additions to the Searchlight 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:
You can find an example spec in doc/source/specs/template.rst. A skeleton that contains all the sections required for a spec file is located in doc/source/specs/skeleton.rst and can be copied, then filled in with the details of a new blueprint for convenience.
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.
Spec reviews were completed entirely through Storyboard:
For more information about working with gerrit, see:
To validate that the specification is syntactically correct (i.e. get more confidence in the Zuul result), please execute the following command:
tox, the documentation will be available for viewing in HTML format in the
doc/build/ directory. Please do not check in the generated HTML files as a part of your commit.