Gear documentation towards a wider audience

Our documentation previously had a statement saying it was primarily
geared towards contributing developers. This commit removes that
statement and replaces it with a more general one. Subsequent patches
are going to be migrating a bunch of useful information for
contributors, developers, and operators alike.

Change-Id: I8cea91b755f53265c21ec72b01939a7c646d3756
This commit is contained in:
Lance Bragstad 2017-06-22 19:50:59 +00:00
parent 0bc462a8c1
commit 82a9970d62
1 changed files with 6 additions and 7 deletions

View File

@ -22,13 +22,9 @@ Keystone is an OpenStack service that provides API client authentication,
service discovery, and distributed multi-tenant authorization by implementing
`OpenStack's Identity API`_.
This documentation is primarily targeted towards contributors of the project,
and assumes that you are already familiar with Keystone from an `end-user
perspective`_; however, end users, deployers, and operators will also find it
useful.
.. _`OpenStack's Identity API`: https://developer.openstack.org/api-ref/identity/v3
.. _`end-user perspective`: https://docs.openstack.org
This documentation is useful for contributors looking to get involved in our
community, developers writing applications on top of OpenStack, and operators
administering their own OpenStack deployments.
This documentation is generated by the Sphinx toolkit and lives in the `source
tree`_. Also see the :doc:`getting-started/community` page for other ways to interact with the
@ -102,8 +98,11 @@ Administrator Guides
API Documentation
~~~~~~~~~~~~~~~~~
An end user can find the specific API documentation here, `OpenStack's Identity API`_.
.. _`OpenStack's Identity API`: https://developer.openstack.org/api-ref/identity/v3
.. note::
Following are some API examples using curl. Note that these examples are not