openstack
/
keystone-specs
Code Issues Proposed changes
OpenStack Identity (Keystone) Specifications
106 Commits 1 Branch 0 Tags 14 MiB
Python 100%
Go to file
Morgan Fainberg 2092b6e9c1 Add project documentation links to index 
Add the project documentation links to the specs index including the
template and the README file.

Change-Id: I53f92795a5718aa69168d6f5e6b5412e1c925e24
 		2014-11-11 19:41:32 +00:00
api/v3 API documentation for Hierarchical Multitenancy 2014-11-11 10:50:01 -03:00
doc/source Add project documentation links to index 2014-11-11 19:41:32 +00:00
specs Add project documentation links to index 2014-11-11 19:41:32 +00:00
tests Add a new section that lists implemented specs for middleware 2014-10-07 16:03:37 -04:00
.gitignore Initial Commit for Identity-specs repo 2014-05-22 16:49:00 -07:00
.gitreview Updated gitreview file for repo rename 2014-05-23 18:34:29 -04:00
.testr.conf Initial Commit for Identity-specs repo 2014-05-22 16:49:00 -07:00
LICENSE Initial Commit for Identity-specs repo 2014-05-22 16:49:00 -07:00
README.rst Backlog 2014-11-11 14:40:31 -05:00
requirements.txt add doc8 validation 2014-10-14 15:38:24 +00:00
setup.cfg Initial Commit for Identity-specs repo 2014-05-22 16:49:00 -07:00
setup.py Updated from global requirements 2014-07-16 00:07:13 +00:00
tox.ini add v3 API documentation 2014-10-17 18:25:42 -04:00

README.rst

OpenStack Identity Specifications

This git repository is used to hold approved design specifications for additions to the Keystone 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 for Keystone specifications is:

specs/<release>/

The layout of this repository for Keystone Client is:

specs/keystoneclient/

When a release of Keystone Client is cut, the implemented blueprints will be moved to a directory specific to that release:

specs/keystoneclient/<release>/

You can find an example spec in specs/template.rst.

For specifications that have been reviewed and approved but have not been implemented:

specs/backlog/

Specifications in this directory indicate the original author has either become unavailable, or has indicated that they are not going to implement the specification. The specifications found here are available as projects for people looking to get involved with Keystone. If you are interested in claiming a spec, start by posting a review for the specification that moves it from this directory to the next active release. Please set yourself as the new primary assignee and maintain the original author in the other contributors list.

Specifications are proposed for a given release by adding them to the specs/<release> directory and posting it for review. Not all approved blueprints will get fully implemented. The implementation status of a blueprint for a given release can be found by looking at the blueprint in Launchpad:

http://blueprints.launchpad.net/keystone/<blueprint-name>

Incomplete 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/keystone

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.