Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Split SSO docs into HowTo/Explanation (Diátaxis) #9801

Merged
merged 21 commits into from
Dec 16, 2022

Conversation

ericholscher
Copy link
Member

@ericholscher ericholscher commented Dec 13, 2022

This is an initial attempt.
I ended up making a couple decisions:

  • Breaking each SSO method out into its own page, to make it clearer and rank better on Google
  • Pulling the content around generic team membership out into its own page, since it wasn't really Google related

There's probably some light finishing touches to clean things up,
but wanted to get this up today.

Refs: #9746

This is an initial attempt.
I ended up making a couple decisions:

* Breaking each SSO method out into its own page, to make it clearer and rank better on Google
* Pulling the content around generic team membership out into its own page, since it wasn't really Google related

There's probably some light finishing touches to clean things up,
but wanted to get this up today.
@ericholscher ericholscher requested review from a team as code owners December 13, 2022 00:28
@ericholscher ericholscher changed the base branch from main to diataxis/main December 13, 2022 00:29
@ericholscher ericholscher changed the title split sso Docs: Split SSO docs into HowTo/Explanation Dec 13, 2022
Copy link
Contributor

@benjaoming benjaoming left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are mostly changes to the content. I think the structure looks good. This seems fairly uncomplicated to move forwards with.

I left some suggestions for covering a few more SSO approaches (email domain, no SSO at all, and suggestions for new SSO support). We can just chat about that, I don't see it as a blocker.

WRT talks about Feature reference, this has a lot of small but critical features. We should consider starting to track these things. I'm wondering if I should open an issue that we can add such things to.

docs/user/commercial/single-sign-on.rst Outdated Show resolved Hide resolved
docs/user/commercial/single-sign-on.rst Show resolved Hide resolved
docs/user/commercial/single-sign-on.rst Outdated Show resolved Hide resolved
docs/user/commercial/single-sign-on.rst Outdated Show resolved Hide resolved
docs/user/commercial/single-sign-on.rst Outdated Show resolved Hide resolved
docs/user/guides/setup-single-sign-on-google-email.rst Outdated Show resolved Hide resolved
docs/user/guides/setup-single-sign-on-google-email.rst Outdated Show resolved Hide resolved
docs/user/guides/setup-single-sign-on-google-email.rst Outdated Show resolved Hide resolved
docs/user/guides/setup-single-sign-on-google-email.rst Outdated Show resolved Hide resolved
docs/user/guides/setup-single-sign-on-google-email.rst Outdated Show resolved Hide resolved
@benjaoming benjaoming added the Improvement Minor improvement to code label Dec 13, 2022
@ericholscher ericholscher requested a review from a team as a code owner December 13, 2022 22:01
Copy link
Member

@humitos humitos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few and small comments 👍🏼

docs/user/guides/manage-read-the-docs-teams.rst Outdated Show resolved Hide resolved
docs/user/guides/manage-read-the-docs-teams.rst Outdated Show resolved Hide resolved
docs/user/guides/setup-single-sign-on-google-email.rst Outdated Show resolved Hide resolved
docs/user/guides/setup-single-sign-on-google-email.rst Outdated Show resolved Hide resolved
docs/user/guides/setup-single-sign-on-google-email.rst Outdated Show resolved Hide resolved
docs/user/_includes/organization-permissions.rst Outdated Show resolved Hide resolved
docs/user/commercial/single-sign-on.rst Outdated Show resolved Hide resolved
docs/user/commercial/single-sign-on.rst Outdated Show resolved Hide resolved
docs/user/guides/setup-single-sign-on-google-email.rst Outdated Show resolved Hide resolved
@ericholscher
Copy link
Member Author

Should be ready to merge if folks want to 👍 it.

I actually wanted to get this in front of a customer today, so now I'm gonna be motivated to get diatasis/main merged into main :)

@benjaoming
Copy link
Contributor

Yes, everything resolved 💯

@benjaoming benjaoming merged commit 8d515c2 into diataxis/main Dec 16, 2022
@benjaoming benjaoming deleted the split-sso branch December 16, 2022 15:23
@ericholscher
Copy link
Member Author

🎉

@benjaoming benjaoming changed the title Docs: Split SSO docs into HowTo/Explanation Docs: Split SSO docs into HowTo/Explanation (Diátaxis) Dec 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants