OpenStack Search (Searchlight) Specifications
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.
Jenkins c80cea39db Merge "Spec for ironic plugin" 2 years ago
doc/source Spec for ironic plugin 2 years ago
images Zero Downtime Reindexing Proposal 3 years ago
specs Spec for ironic plugin 2 years ago
tests Setup Initial Spec Repo Contents 3 years ago
.gitignore Setup Initial Spec Repo Contents 3 years ago
.gitreview Added .gitreview 3 years ago
.testr.conf Setup Initial Spec Repo Contents 3 years ago
LICENSE Setup Initial Spec Repo Contents 3 years ago
README.rst Setup Initial Spec Repo Contents 3 years ago
requirements.txt Setup Initial Spec Repo Contents 3 years ago
setup.cfg Setup Initial Spec Repo Contents 3 years ago
setup.py Setup Initial Spec Repo Contents 3 years ago
tox.ini Setup Initial Spec Repo Contents 3 years ago

README.rst

OpenStack Searchlight Specifications

Please read the Searchlight process documentation on feature requests and bug reports:

http://docs.openstack.org/developer/searchlight/feature-requests-bugs.html

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:

specs/<release>/

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.

Prior to the Miktaka development cycle, this repository was not used for spec reviews. Reviews prior to Mitaka were completed entirely through Launchpad blueprints:

http://blueprints.launchpad.net/searchlight

For more information about working with gerrit, see:

http://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

After running 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.