Uploaded image for project: 'Red Hat Developer Hub Bugs'
  1. Red Hat Developer Hub Bugs
  2. RHDHBUGS-2297

[Docs] Improve Conceptual Explanation of Authentication Flow and Relationship Between Auth and Catalog Providers

XMLWordPrintable

    • 2
    • False
    • Hide

      None

      Show
      None
    • False

      Feedback indicates that the relationship between authentication providers and catalog providers in RHDH is not clearly explained, leading to confusion for users setting up authentication. It is not immediately obvious that catalog provisioning is a prerequisite for using any authentication provider, and the current documentation does not emphasize this strongly enough.

      Although recent restructuring efforts attempted to clarify this, the documentation may benefit from stronger, more explicit language in the introduction sections of each authentication provider.

      Documentation improvements:

      • Add a clear conceptual overview explaining how authentication works within RHDH, including the flow between:
        • Auth providers
        • Catalog providers
        • User provisioning
      • Explicitly state that provisioning users in the catalog is required for authentication providers to function correctly.
      • Strengthen introductory text in each auth provider section to highlight this dependency.
      • Review and update the existing “Authenticating with RHBK” section to ensure the relationship between auth and catalog is prominently communicated.

      These updates will help reduce confusion, improve setup accuracy, and give users a clearer conceptual model of the authentication pipeline.

              Unassigned Unassigned
              hmanwani@redhat.com Heena Manwani
              RHIDP - Documentation
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: