From c2fd1f6af54f4518dc29e71d0a9c15e80f608984 Mon Sep 17 00:00:00 2001 From: Colleen Murphy Date: Tue, 13 Sep 2016 15:40:53 -0700 Subject: [PATCH] Fix links on configure_federation documentation When the API reference was moved and the old pages cleaned up, a lot of dead links were created. This patch fixes them for the documentation on "Configuring Keystone for Federation". Moreover, a lot of the link text was nondescriptive, which makes the documentation inaccessible for screen readers (see the W3C guideline[1]). This patch cleans that up as well if the link URL needed to be updated anyway. [1] https://www.w3.org/TR/WCAG20-TECHS/H30.html Change-Id: I58803276d9b06bad0252da2494c81a46c951916f --- .../federation/configure_federation.rst | 30 +++++++++---------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/doc/source/federation/configure_federation.rst b/doc/source/federation/configure_federation.rst index ef3f006699..8dc1f6017b 100644 --- a/doc/source/federation/configure_federation.rst +++ b/doc/source/federation/configure_federation.rst @@ -116,9 +116,9 @@ correspond to the Identity Provider's groups; additionally, these groups should be assigned roles on one or more projects or domains. You may be interested in more information on `group management -`_ +`_ and `role assignments -`_, +`_, both of which are exposed to the CLI via `python-openstackclient `_. @@ -131,8 +131,8 @@ To utilize federation the following must be created in the Identity Service: * Mapping * Protocol -More information on ``federation in keystone`` can be found `here -`__. +Read more about `federation in keystone +`__. ~~~~~~~~~~~~~~~~~ Identity Provider @@ -141,8 +141,8 @@ Identity Provider Create an Identity Provider object in keystone, which represents the Identity Provider we will use to authenticate end users. -More information on identity providers can be found `here -`__. +Read more about `identity providers +`__. ~~~~~~~ Mapping @@ -157,8 +157,8 @@ rules can be found on the :doc:`mapping_combinations` page. An Identity Provider has exactly one mapping specified per protocol. Mapping objects can be used multiple times by different combinations of Identity Provider and Protocol. -More information on mapping can be found `here -`__. +Read more about `mapping +`__. ~~~~~~~~ Protocol @@ -168,7 +168,7 @@ A protocol contains information that dictates which Mapping rules to use for an request made by an IdP. An IdP may have multiple supported protocols. Add `Protocol object -`__ and specify the mapping id +`__ and specify the mapping id you want to use with the combination of the IdP and Protocol. Performing federated authentication @@ -197,8 +197,8 @@ a token will be returned in XML format. In the returned unscoped token, a list of Identity Service groups the user belongs to will be included. -More information on getting an unscoped token can be found `here -`__. +Read more about `getting an unscoped token +`__. ~~~~~~~~~~~~ Example cURL @@ -222,8 +222,8 @@ projects and domains that are accessible. * List projects a federated user can access: ``GET /OS-FEDERATION/projects`` * List domains a federated user can access: ``GET /OS-FEDERATION/domains`` -More information on listing resources can be found `here -`__. +Read more about `listing resources +`__. ~~~~~~~~~~~~ Example cURL @@ -246,8 +246,8 @@ A federated user may request a scoped token, by using the unscoped token. A project or domain may be specified by either ``id`` or ``name``. An ``id`` is sufficient to uniquely identify a project or domain. -More information on getting a scoped token can be found `here -`__. +Read more about `getting a scoped token +`__. ~~~~~~~~~~~~ Example cURL