← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1793374] [NEW] Federated documentations lacks a concise introduction

 

Public bug reported:

The documentation for federated identity [0] doesn't clearly describe
what the purpose of federated identity is or why someone would want to
use it.

This was apparent during the Stein PTG in Denver [1] when working with a
set of people with fresh perspectives. Most regular keystone
contributors have such an in-depth understanding of identity federation
that it makes us gloss over some things that might be confusing to new-
comers.

This bug is to track reworking the federated identity documentation to
include a clear and concise introduction that helps people understand
the purpose of federation before leading them into technical details.

The introduction should try and describe the following:

What is identity federation?
Why is it useful?
What is SAML?
What protocols can be used?
What are the benefits of using different protocols, if any?

[0] https://etherpad.openstack.org/p/keystone-stein-federation
[1] https://docs.openstack.org/keystone/latest/advanced-topics/federation/federated_identity.html

** Affects: keystone
     Importance: Low
     Assignee: Colleen Murphy (krinkle)
         Status: Triaged


** Tags: documentation federation

** Changed in: keystone
   Importance: Undecided => Low

** Changed in: keystone
       Status: New => Triaged

** Tags added: documentation

** Tags added: federation

** Description changed:

  The documentation for federated identity [0] doesn't clearly describe
  what the purpose of federated identity is or why someone would want to
  use it.
  
  This was apparent during the Stein PTG in Denver [1] when working with a
  set of people with fresh perspectives. Most regular keystone
  contributors have such an in-depth understanding of identity federation
  that it makes us gloss over some things that might be confusing to new-
  comers.
  
  This bug is to track reworking the federated identity documentation to
  include a clear and concise introduction that helps people understand
  the purpose of federation before leading them into technical details.
  
+ The introduction should try and describe the following:
+ 
+ What is identity federation?
+ Why is it useful?
+ What is SAML?
+ What protocols can be used?
+ What are the benefits of using different protocols, if any?
  
  [0] https://etherpad.openstack.org/p/keystone-stein-federation
  [1] https://docs.openstack.org/keystone/latest/advanced-topics/federation/federated_identity.html

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Identity (keystone).
https://bugs.launchpad.net/bugs/1793374

Title:
  Federated documentations lacks a concise introduction

Status in OpenStack Identity (keystone):
  Triaged

Bug description:
  The documentation for federated identity [0] doesn't clearly describe
  what the purpose of federated identity is or why someone would want to
  use it.

  This was apparent during the Stein PTG in Denver [1] when working with
  a set of people with fresh perspectives. Most regular keystone
  contributors have such an in-depth understanding of identity
  federation that it makes us gloss over some things that might be
  confusing to new-comers.

  This bug is to track reworking the federated identity documentation to
  include a clear and concise introduction that helps people understand
  the purpose of federation before leading them into technical details.

  The introduction should try and describe the following:

  What is identity federation?
  Why is it useful?
  What is SAML?
  What protocols can be used?
  What are the benefits of using different protocols, if any?

  [0] https://etherpad.openstack.org/p/keystone-stein-federation
  [1] https://docs.openstack.org/keystone/latest/advanced-topics/federation/federated_identity.html

To manage notifications about this bug go to:
https://bugs.launchpad.net/keystone/+bug/1793374/+subscriptions


Follow ups