openstack
/
keystone
Code Issues Proposed changes

Clean up the introductory text in the docs 

I made a few specific changes, hopefully for the better:

- Removed the "Welcome!" from the title, which is quite verbose in the
  sidebar index (and reads awkwardly as a title, IMO).

- Revised the project description to match what's on our Launchpad page,
  https://launchpad.net/keystone

- Revised the target audience to more accurately reflect who we actually
  write for (it's still contributors first, but it's not fair to ignore
  operators, etc).

Change-Id: I9955f31216e7a70fed10501f096001433609ac70
This commit is contained in:
Dolph Mathews 2016-08-03 09:59:05 -05:00
parent b79e08b9bc
commit bfa13b7a64
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/source/index.rst
View File

@ -14,16 +14,18 @@
License for the specific language governing permissions and limitations
under the License.
====================================================
Welcome to Keystone, the OpenStack Identity Service!
====================================================
========================================
Keystone, the OpenStack Identity Service
========================================
Keystone is an OpenStack project that provides Identity, Token, Catalog and
Policy services for use specifically by projects in the OpenStack family.
It implements `OpenStack's Identity API`_.
Keystone is an OpenStack service that provides API client authentication,
service discovery, and distributed multi-tenant authorization by implementing
`OpenStack's Identity API`_.
This document describes Keystone for contributors of the project, and assumes
that you are already familiar with Keystone from an `end-user perspective`_.
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`: http://specs.openstack.org/openstack/keystone-specs/
.. _`end-user perspective`: http://docs.openstack.org/