Metadata-Version: 1.1
Name: searchlight-specs
Version: 0.0.1.dev53
Summary: OpenStack Searchlight Project Development Specs
Home-page: https://specs.openstack.org/openstack/searchlight-specs/
Author: OpenStack
Author-email: openstack-discuss@lists.openstack.org
License: UNKNOWN
Description: ========================
        Team and repository tags
        ========================
        
        .. image:: https://governance.openstack.org/tc/badges/searchlight-specs.svg
            :target: https://governance.openstack.org/tc/reference/tags/index.html
        
        .. Change things from this point on
        
        ====================================
        OpenStack Searchlight Specifications
        ====================================
        
        Please read the Searchlight process documentation on feature requests and bug reports:
        
           https://docs.openstack.org/searchlight/latest/contributor/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.
        
        Spec reviews were completed entirely through Storyboard::
        
          https://storyboard.openstack.org/#!/project_group/93
        
        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 Zuul 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.
        
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
