keystone/README.rst

==================
OpenStack Keystone
==================

.. image:: https://governance.openstack.org/tc/badges/keystone.svg
    :target: https://governance.openstack.org/tc/reference/tags/index.html

.. Change things from this point on

OpenStack Keystone provides authentication, authorization and service discovery
mechanisms via HTTP primarily for use by projects in the OpenStack family. It
is most commonly deployed as an HTTP interface to existing identity systems,
such as LDAP.

Developer documentation, the source of which is in ``doc/source/``, is
published at:

    https://docs.openstack.org/keystone/latest

The API reference and documentation are available at:

    https://docs.openstack.org/api-ref/identity

The canonical client library is available at:

    https://opendev.org/openstack/python-keystoneclient

Documentation for cloud administrators is available at:

    https://docs.openstack.org/

The source of documentation for cloud administrators is available at:

    https://opendev.org/openstack/openstack-manuals

Information about our team meeting is available at:

    https://wiki.openstack.org/wiki/Meetings/KeystoneMeeting

Release notes is available at:

    https://docs.openstack.org/releasenotes/keystone

Bugs and feature requests are tracked on Launchpad at:

    https://bugs.launchpad.net/keystone

Future design work is tracked at:

    https://specs.openstack.org/openstack/keystone-specs

Contributors are encouraged to join IRC (``#openstack-keystone`` on freenode):

    https://wiki.openstack.org/wiki/IRC

Source for the project:

    https://opendev.org/openstack/keystone

For information on contributing to Keystone, see ``CONTRIBUTING.rst``.
Start README.rst with a better title Now that we are using gitea the contents of our README.rst are more prominently displayed. Starting it with a "Team and repository tags" title is a bit confusing. This change makes it start with the name of the project instead. Change-Id: Ib2b1397cd97b698ce26690485b74a778f6274865 2019-11-19 17:34:45 +01:00			`==================`
			`OpenStack Keystone`
			`==================`
Show team and repo badges on README This patch adds the team's and repository's badges to the README file. The motivation behind this is to communicate the project status and features at first glance. For more information about this effort, please read this email thread: http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html To see an example of how this would look like check: https://gist.github.com/fc47e904c942eace9b274fbc46f5d27d Change-Id: I61fd31c923c100cf4c81ef2b287621193a0c6c29 2016-11-25 09:56:40 +01:00
Update links in README Change the outdated links to the latest links in README Change-Id: I1e419297fa156eda2b48264c147062add8d71ab2 2018-03-11 01:14:03 +08:00			`.. image:: https://governance.openstack.org/tc/badges/keystone.svg`
			`:target: https://governance.openstack.org/tc/reference/tags/index.html`
Show team and repo badges on README This patch adds the team's and repository's badges to the README file. The motivation behind this is to communicate the project status and features at first glance. For more information about this effort, please read this email thread: http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html To see an example of how this would look like check: https://gist.github.com/fc47e904c942eace9b274fbc46f5d27d Change-Id: I61fd31c923c100cf4c81ef2b287621193a0c6c29 2016-11-25 09:56:40 +01:00
			`.. Change things from this point on`

Start README.rst with a better title Now that we are using gitea the contents of our README.rst are more prominently displayed. Starting it with a "Team and repository tags" title is a bit confusing. This change makes it start with the name of the project instead. Change-Id: Ib2b1397cd97b698ce26690485b74a778f6274865 2019-11-19 17:34:45 +01:00			`OpenStack Keystone provides authentication, authorization and service discovery`
Rewrite README.rst Most of the content in the README is unmaintained and out of date, and can be replaced by references to documentation that is more properly maintained. This patch replaces most of the contents of the README with low maintenance links. Fixes-Bug: 1227734 Change-Id: I4d63d971f94329197bd7001682d0d655901457f0 2013-09-19 10:23:24 -05:00			`mechanisms via HTTP primarily for use by projects in the OpenStack family. It`
			`is most commonly deployed as an HTTP interface to existing identity systems,`
			`such as LDAP.`
initial 2011-06-20 17:56:20 -07:00
Rewrite README.rst Most of the content in the README is unmaintained and out of date, and can be replaced by references to documentation that is more properly maintained. This patch replaces most of the contents of the README with low maintenance links. Fixes-Bug: 1227734 Change-Id: I4d63d971f94329197bd7001682d0d655901457f0 2013-09-19 10:23:24 -05:00			Developer documentation, the source of which is in ``doc/source/``, is
			`published at:`
add crud info to readme 2011-11-04 15:56:17 -07:00
Update URL in README.rst Change-Id: I759356fa7b17a1a1166f2fe2833fe0e28e9c4b06 2017-08-08 12:55:36 +05:30			`https://docs.openstack.org/keystone/latest`
initial 2011-06-20 17:56:20 -07:00
Update API reference link in README We've long moved api-ref out of keystone-specs. Also shortens the link to keystone-specs. Change-Id: I77f578b4d991e563e4337da2484fb7ddc09991c6 2017-09-14 14:04:12 -06:00			`The API reference and documentation are available at:`
removing the sphinx_build from setup.py, adding how to run the docs into the README 2012-01-20 20:51:54 +00:00
Update api-ref location The api documentation is now published on docs.openstack.org instead of developer.openstack.org. Update all links that are changed to the new location. This does not relationship URIs since "these links do not resolve to anything valid, but exist to show a relationship." Note that redirects will be set up as well but let's point now to the new location. For details, see: http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html Change-Id: I6efdf375bc8e1e5ca2b113337002d6178180a1e1 2019-07-22 18:43:51 +02:00			`https://docs.openstack.org/api-ref/identity`
updating readme to point to developer setup docs * fixes bug 945274 Change-Id: I6caf8da9fd0bd5647ae913efd752dd6651abcb85 2012-03-02 16:39:10 -08:00
Rewrite README.rst Most of the content in the README is unmaintained and out of date, and can be replaced by references to documentation that is more properly maintained. This patch replaces most of the contents of the README with low maintenance links. Fixes-Bug: 1227734 Change-Id: I4d63d971f94329197bd7001682d0d655901457f0 2013-09-19 10:23:24 -05:00			`The canonical client library is available at:`
Removed old sections; improved syntax consistency Change-Id: Iff07ce0f0eac8f64fab30af92a82a1fdca5278de 2012-05-02 09:57:45 -05:00
Replace git.openstack.org URLs with opendev.org URLs Thorough replacement of git.openstack.org URLs with their opendev.org counterparts. Change-Id: I7cd39dacaa1f2cdc2d74da39ae3971246e922907 2019-04-22 12:03:56 +08:00			`https://opendev.org/openstack/python-keystoneclient`
removing the sphinx_build from setup.py, adding how to run the docs into the README 2012-01-20 20:51:54 +00:00
Rewrite README.rst Most of the content in the README is unmaintained and out of date, and can be replaced by references to documentation that is more properly maintained. This patch replaces most of the contents of the README with low maintenance links. Fixes-Bug: 1227734 Change-Id: I4d63d971f94329197bd7001682d0d655901457f0 2013-09-19 10:23:24 -05:00			`Documentation for cloud administrators is available at:`
removing the sphinx_build from setup.py, adding how to run the docs into the README 2012-01-20 20:51:54 +00:00
Use https for docs.openstack.org references The openstack.org pages now support https and our references to the site should by default be one signed by the organization. Change-Id: I30a462e03d1fd7852511e22cac34c6bc0e8917f4 2017-01-30 13:53:09 -08:00			`https://docs.openstack.org/`
removing the sphinx_build from setup.py, adding how to run the docs into the README 2012-01-20 20:51:54 +00:00
Rewrite README.rst Most of the content in the README is unmaintained and out of date, and can be replaced by references to documentation that is more properly maintained. This patch replaces most of the contents of the README with low maintenance links. Fixes-Bug: 1227734 Change-Id: I4d63d971f94329197bd7001682d0d655901457f0 2013-09-19 10:23:24 -05:00			`The source of documentation for cloud administrators is available at:`
removing the sphinx_build from setup.py, adding how to run the docs into the README 2012-01-20 20:51:54 +00:00
Replace git.openstack.org URLs with opendev.org URLs Thorough replacement of git.openstack.org URLs with their opendev.org counterparts. Change-Id: I7cd39dacaa1f2cdc2d74da39ae3971246e922907 2019-04-22 12:03:56 +08:00			`https://opendev.org/openstack/openstack-manuals`
Removed old sections; improved syntax consistency Change-Id: Iff07ce0f0eac8f64fab30af92a82a1fdca5278de 2012-05-02 09:57:45 -05:00
Rewrite README.rst Most of the content in the README is unmaintained and out of date, and can be replaced by references to documentation that is more properly maintained. This patch replaces most of the contents of the README with low maintenance links. Fixes-Bug: 1227734 Change-Id: I4d63d971f94329197bd7001682d0d655901457f0 2013-09-19 10:23:24 -05:00			`Information about our team meeting is available at:`
documentation driven development 2011-12-27 11:20:55 -08:00
Rewrite README.rst Most of the content in the README is unmaintained and out of date, and can be replaced by references to documentation that is more properly maintained. This patch replaces most of the contents of the README with low maintenance links. Fixes-Bug: 1227734 Change-Id: I4d63d971f94329197bd7001682d0d655901457f0 2013-09-19 10:23:24 -05:00			`https://wiki.openstack.org/wiki/Meetings/KeystoneMeeting`
documentation driven development 2011-12-27 11:20:55 -08:00
Add release notes link to README Change-Id: I02e58c986dd11dbf6344e0beb346cc567eb0131e 2018-06-12 15:30:45 +08:00			`Release notes is available at:`

			`https://docs.openstack.org/releasenotes/keystone`

Rewrite README.rst Most of the content in the README is unmaintained and out of date, and can be replaced by references to documentation that is more properly maintained. This patch replaces most of the contents of the README with low maintenance links. Fixes-Bug: 1227734 Change-Id: I4d63d971f94329197bd7001682d0d655901457f0 2013-09-19 10:23:24 -05:00			`Bugs and feature requests are tracked on Launchpad at:`
documentation driven development 2011-12-27 11:20:55 -08:00
Rewrite README.rst Most of the content in the README is unmaintained and out of date, and can be replaced by references to documentation that is more properly maintained. This patch replaces most of the contents of the README with low maintenance links. Fixes-Bug: 1227734 Change-Id: I4d63d971f94329197bd7001682d0d655901457f0 2013-09-19 10:23:24 -05:00			`https://bugs.launchpad.net/keystone`
documentation driven development 2011-12-27 11:20:55 -08:00
Rewrite README.rst Most of the content in the README is unmaintained and out of date, and can be replaced by references to documentation that is more properly maintained. This patch replaces most of the contents of the README with low maintenance links. Fixes-Bug: 1227734 Change-Id: I4d63d971f94329197bd7001682d0d655901457f0 2013-09-19 10:23:24 -05:00			`Future design work is tracked at:`
documentation driven development 2011-12-27 11:20:55 -08:00
Update API reference link in README We've long moved api-ref out of keystone-specs. Also shortens the link to keystone-specs. Change-Id: I77f578b4d991e563e4337da2484fb7ddc09991c6 2017-09-14 14:04:12 -06:00			`https://specs.openstack.org/openstack/keystone-specs`
documentation driven development 2011-12-27 11:20:55 -08:00
Keystone team uses #openstack-keystone now Keystone Team uses #openstack-keystone for IRC chatter now. Any cross project topics still should be in #openstack-dev. Change-Id: Ie4c6d6aee3bbdd8206fc0e5b00ecabfcaa265cb2 2014-02-18 10:57:25 -08:00			Contributors are encouraged to join IRC (``#openstack-keystone`` on freenode):
add IRC channel & wiki link to README Change-Id: I03404978af83784e9ffe35319410eb59559c9630 2013-10-16 12:55:18 -05:00
			`https://wiki.openstack.org/wiki/IRC`

Add Source links to readme Change-Id: Ibf1c54861873b38df0ba14b5971f6d8bf5fd6fb7 2019-10-17 14:24:28 +08:00			`Source for the project:`

			`https://opendev.org/openstack/keystone`

Rewrite README.rst Most of the content in the README is unmaintained and out of date, and can be replaced by references to documentation that is more properly maintained. This patch replaces most of the contents of the README with low maintenance links. Fixes-Bug: 1227734 Change-Id: I4d63d971f94329197bd7001682d0d655901457f0 2013-09-19 10:23:24 -05:00			For information on contributing to Keystone, see ``CONTRIBUTING.rst``.