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: move sso how to guides to the how-to folder #2323

Merged
merged 7 commits into from Nov 14, 2022

Conversation

sighphyre
Copy link
Member

We're in the process of moving how-to guides into the how-to folder, where they belong. This continues that work and shifts the how to guides for SSO to the correct place and gives them appropriate names

@vercel
Copy link

vercel bot commented Nov 3, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated
unleash-docs ❌ Failed (Inspect) Nov 14, 2022 at 0:10AM (UTC)
unleash-monorepo-frontend ✅ Ready (Inspect) Visit Preview 💬 Add your feedback Nov 14, 2022 at 0:10AM (UTC)

Copy link
Contributor

@thomasheartman thomasheartman left a comment

Choose a reason for hiding this comment

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

You're doing the proverbial Lord's work here, Simon! 🙌🏼 This looks great, but changing the file locations also changes their URL, so you'll need to add the corresponding redirects:

Check out the plugin-client-redirects in website/docusaurus.config.js. Just add the old path and the new ones. Be aware that the redirects aren't active in development mode, so you'll need to use a production build to test that they work. There's more info in docusaurus' plugin-client-redirect docs.

Otherwise, I've also added suggestions to use docusaurus' admonitions for availability and deprecation notices. It's not really part of the relocation, but it might be nice to do regardless.

website/docs/how-to/how-to-add-sso-google.md Outdated Show resolved Hide resolved
website/docs/how-to/how-to-add-sso-saml-keycloak.md Outdated Show resolved Hide resolved
website/docs/how-to/how-to-add-sso-open-id-connect.md Outdated Show resolved Hide resolved
website/docs/how-to/how-to-add-sso-saml.md Outdated Show resolved Hide resolved
sighphyre and others added 4 commits November 3, 2022 15:00
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
@sighphyre
Copy link
Member Author

You're doing the proverbial Lord's work here, Simon!

Gosh that made me blush. I think it's time, yeah, if we're going to go forwards with new patterns, let's go forwards. Happy to help

Check out the plugin-client-redirects in website/docusaurus.config.js. Just add the old path and the new ones. Be aware that the redirects aren't active in development mode, so you'll need to use a production build to test that they work. There's more info in docusaurus' plugin-client-redirect docs.

Otherwise, I've also added suggestions to use docusaurus' admonitions for availability and deprecation notices. It's not really part of the relocation, but it might be nice to do regardless.

Amazing, thank you! I will take a look today, I figured there was probably something I was missing here so thanks for the pointer!

Copy link
Contributor

@thomasheartman thomasheartman left a comment

Choose a reason for hiding this comment

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

This looks good to me now 😄

@thomasheartman
Copy link
Contributor

I've also gone through and tested all the redirects you've added, by the way. They work as expected 🥳

@sighphyre
Copy link
Member Author

I've also gone through and tested all the redirects you've added, by the way. They work as expected partying_face

You're amazing, thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

2 participants