[v18] Refactor SSO docs to improve readability#62410
Merged
ptgott merged 1 commit intobranch/v18from Jan 5, 2026
Merged
Conversation
9bb17d3 to
49cf443
Compare
Contributor
|
Amplify deployment status
|
49cf443 to
f50cbdf
Compare
f50cbdf to
24d998e
Compare
24d998e to
ded2356
Compare
hugoShaka
approved these changes
Dec 23, 2025
ded2356 to
2c94494
Compare
mmcallister
approved these changes
Dec 27, 2025
Backports #61492 The SSO documentation currently consists of: - One long conceptual guide - IdP-specific how-to guides The conceptual guide holds a collection of topics with no unifying theme besides Teleport's SSO support, making it difficult to discover topics for readers who have not made their way through the entire guide. This change aims to improve the discoverability of SSO topics by: - Splitting the conceptual guide into multiple pages - Moving IdP-specific guides into their own subsection - Moving the Login Rules docs, which only make sense if a user is setting up SSO, into the SSO section of the docs. To split the main conceptual guide, this change: - Turns the SSO for MFA section into a how-to guide. This mostly the structure of a how-to guide, but we couldn't use this structure because this text was a section of the conceptual SSO guide. By splitting the SSO guide, we can make this a how-to guide. - Move the "Changing callback address" section into a partial that we can include in the IdP-specific how-to guides, since the level of detail within this section is consistent with those guides. - Move "Working with an external identity". This belongs in Role Templates, and has the wrong level of detail for an overview of SSO. To get this to work, add H3s to the interpolation section of the Role Templates guide. - Move all content re: configuring specific authentication connector fields into the section index page for the IdP-specific guides. - Remove the Troubleshooting section. This text is repeated using a partial in every IdP-specific guide, and is the wrong level of detail for a general overview. - Move the Login Rules example to where we include other Login Rule examples, in the Login Rules guide. - Remove the tabbed examples of authentication connectors from the SSO index page. There is not nearly enough context on this page to help a reader make use of these examples. Instead, refer the reader to the IdP-specific how-to guides. - Move "multiple SSO provider" discussion to its own page.
2c94494 to
ac3ba1a
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Backports #61492
The SSO documentation currently consists of:
The conceptual guide holds a collection of topics with no unifying theme besides Teleport's SSO support, making it difficult to discover topics for readers who have not made their way through the entire guide. This change aims to improve the discoverability of SSO topics by:
To split the main conceptual guide, this change: