diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..cd5fb7c --- /dev/null +++ b/LICENSE @@ -0,0 +1,3 @@ +This work is licensed under a Creative Commons Attribution 3.0 Unported License. + +http://creativecommons.org/licenses/by/3.0/legalcode \ No newline at end of file diff --git a/README.md b/README.md deleted file mode 100644 index fea9b53..0000000 --- a/README.md +++ /dev/null @@ -1,4 +0,0 @@ -barbican-specs -============== - -Seed repository for the stackforge/barbican-specs repo. Used for approving blueprints for the Barbican project. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..7019783 --- /dev/null +++ b/README.rst @@ -0,0 +1,45 @@ +================================== +OpenStack Barbican Specifications +================================== + +This git repository is used to hold approved design specifications for additions +to the Barbican 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// + +You can find an example spec in `specs/template.rst`. + +Specifications are proposed for a given release by adding them to the +`specs/` 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 Juno development cycle, this repository was not used for spec +reviews. Reviews prior to Juno were completed entirely through Launchpad +blueprints:: + + http://blueprints.launchpad.net/barbican + +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://wiki.openstack.org/wiki/Gerrit_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. \ No newline at end of file