-
Epic
-
Resolution: Done
-
Major
-
None
-
None
-
Improve clarity, readability, and accuracy of authentication docs
-
M
-
False
-
-
False
-
-
In Progress
-
RHIDP-6729 - Improve Auth Provider onboarding/serviceability
-
QE Needed, Docs Needed, TE Needed, Customer Facing, PX Needed
-
33% To Do, 0% In Progress, 67% Done
-
-
EPIC Goal
Improve the clarity, readability, and accuracy of the authentication product docs by collaborating with the docs team.
Review and follow all existing auth docs and test for accuracy. Consider the tone and word choice of the instructions, and add high-level overviews of how authentication and catalog ingesters work together.
Background/Feature Origin
From support tickets and customer interactions, we have received feedback that the docs are at times hard to consume, miss contextual information, or contain incorrect configs.
Why is this important?
This is important for improving the onboarding experience for customers and minimizing the number of support issues.
User Scenarios
As a new customer setting up RHDH auth and user/group ingestion, I want to understand the required components/plugins: how they work together and why each one necessary
Dependencies (internal and external)
Acceptance Criteria
Release Enablement/Demo - Provide necessary release enablement details
and documents
DEV - Upstream code and tests merged: <link to meaningful PR or GitHub
Issue>
DEV - Upstream documentation merged: <link to meaningful PR or GitHub
Issue>
DEV - Downstream build attached to advisory: <link to errata>
QE - Test plans in Playwright: <link or reference to playwright>
QE - Automated tests merged: <link or reference to automated tests>
DOC - Downstream documentation merged: <link to meaningful PR>
