From 3624cdc21f27d799a2457314ac196ef9accfa8d9 Mon Sep 17 00:00:00 2001 From: Simon Hornby Date: Mon, 14 Nov 2022 14:11:27 +0200 Subject: [PATCH] docs: move sso how to guides to the how-to folder (#2323) 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 Co-authored-by: Thomas Heartman --- website/docs/advanced/sso.md | 8 ++++---- .../how-to-add-sso-google.md} | 9 ++++++--- .../how-to-add-sso-open-id-connect.md} | 9 ++++++--- .../how-to-add-sso-saml-keycloak.md} | 9 ++++++--- .../how-to-add-sso-saml.md} | 9 ++++++--- website/docusaurus.config.js | 16 ++++++++++++++++ website/sidebars.js | 8 ++++---- 7 files changed, 48 insertions(+), 20 deletions(-) rename website/docs/{advanced/sso-google.md => how-to/how-to-add-sso-google.md} (91%) rename website/docs/{advanced/sso-open-id-connect.md => how-to/how-to-add-sso-open-id-connect.md} (92%) rename website/docs/{advanced/sso-saml-keycloak.md => how-to/how-to-add-sso-saml-keycloak.md} (91%) rename website/docs/{advanced/sso-saml.md => how-to/how-to-add-sso-saml.md} (96%) diff --git a/website/docs/advanced/sso.md b/website/docs/advanced/sso.md index 632975d56f..fdbb4ee4d7 100644 --- a/website/docs/advanced/sso.md +++ b/website/docs/advanced/sso.md @@ -18,7 +18,7 @@ In order to configure Single-Sign-On you will need to log in to the Unleash inst Unleash enterprise supports multiple authentication providers. -- [OpenID Connect with Okta](./sso-open-id-connect.md) -- [SAML 2.0 with Okta](./sso-saml.md) -- [SAML 2.0 with Keycloak](./sso-saml-keycloak.md) -- [Google Authentication](./sso-google.md) (deprecated) +- [OpenID Connect with Okta](../how-to/how-to-add-sso-open-id-connect.md) +- [SAML 2.0 with Okta](../how-to/how-to-add-sso-saml.md) +- [SAML 2.0 with Keycloak](../how-to/how-to-add-sso-saml-keycloak.md) +- [Google Authentication](../how-to/how-to-add-sso-google.md) (deprecated) diff --git a/website/docs/advanced/sso-google.md b/website/docs/how-to/how-to-add-sso-google.md similarity index 91% rename from website/docs/advanced/sso-google.md rename to website/docs/how-to/how-to-add-sso-google.md index 6e43d831ee..0fcd6e50ae 100644 --- a/website/docs/advanced/sso-google.md +++ b/website/docs/how-to/how-to-add-sso-google.md @@ -1,13 +1,16 @@ --- -id: sso-google title: '[Deprecated] How to add SSO with Google' --- -> Single Sign-on via the Google Authenticator provider is deprecated. We recommend using [OpenID Connect](./sso-open-id-connect.md) instead. +:::caution Deprecation notice + +Single Sign-on via the Google Authenticator provider is deprecated. We recommend using [OpenID Connect](./how-to-add-sso-open-id-connect.md) instead. + +::: ## Introduction {#introduction} -In this guide we will do a deep dive on the Single-Sign-On (SSO) using Google Authentication. Unleash supports other identity providers and protocols, have a look at [all available Single-Sign-On options](./sso.md) +In this guide we will do a deep dive on the Single-Sign-On (SSO) using Google Authentication. Unleash supports other identity providers and protocols, have a look at [all available Single-Sign-On options](../advanced/sso.md) ## Basic configuration diff --git a/website/docs/advanced/sso-open-id-connect.md b/website/docs/how-to/how-to-add-sso-open-id-connect.md similarity index 92% rename from website/docs/advanced/sso-open-id-connect.md rename to website/docs/how-to/how-to-add-sso-open-id-connect.md index 102c1b0518..f3ef243911 100644 --- a/website/docs/advanced/sso-open-id-connect.md +++ b/website/docs/how-to/how-to-add-sso-open-id-connect.md @@ -1,13 +1,16 @@ --- -id: sso-open-id-connect title: How to add SSO with OpenID Connect --- -> The **Single-Sign-On capability** is only available for customers on the Enterprise subscription. Check out the [Unleash plans](https://www.getunleash.io/plans) for details. +:::note Availability + +The **Single-Sign-On capability** is only available for customers on the Enterprise subscription. Check out the [Unleash plans](https://www.getunleash.io/plans) for details. + +::: ## Introduction {#introduction} -In this guide we will do a deep dive on the Single-Sign-On (SSO) using the OpenID Connect protocol and connect it with Okta as IdP. Unleash supports other identity providers and protocols, have a look at [all available Single-Sign-On options](./sso.md) +In this guide we will do a deep dive on the Single-Sign-On (SSO) using the OpenID Connect protocol and connect it with Okta as IdP. Unleash supports other identity providers and protocols, have a look at [all available Single-Sign-On options](../advanced/sso.md) ## Basic configuration diff --git a/website/docs/advanced/sso-saml-keycloak.md b/website/docs/how-to/how-to-add-sso-saml-keycloak.md similarity index 91% rename from website/docs/advanced/sso-saml-keycloak.md rename to website/docs/how-to/how-to-add-sso-saml-keycloak.md index 1d55381176..8541af8a65 100644 --- a/website/docs/advanced/sso-saml-keycloak.md +++ b/website/docs/how-to/how-to-add-sso-saml-keycloak.md @@ -1,13 +1,16 @@ --- -id: sso-saml-keycloak title: How to add SSO with SAML 2.0 Keycloak --- -> The **Single-Sign-On capability** is only available for customers on the Enterprise subscription. Check out the [Unleash plans](https://www.getunleash.io/plans) for details. +:::note Availability + +The **Single-Sign-On capability** is only available for customers on the Enterprise subscription. Check out the [Unleash plans](https://www.getunleash.io/plans) for details. + +::: ## Introduction {#introduction} -In this guide we will do a deep dive on the Single-Sign-On (SSO) integration with SAML 2.0 and connect it with Keycloak as IdP. Unleash supports other identity providers and protocols, have a look at [all available Single-Sign-On options](./sso.md) +In this guide we will do a deep dive on the Single-Sign-On (SSO) integration with SAML 2.0 and connect it with Keycloak as IdP. Unleash supports other identity providers and protocols, have a look at [all available Single-Sign-On options](../advanced/sso.md) ## Basic configuration diff --git a/website/docs/advanced/sso-saml.md b/website/docs/how-to/how-to-add-sso-saml.md similarity index 96% rename from website/docs/advanced/sso-saml.md rename to website/docs/how-to/how-to-add-sso-saml.md index 86669a308a..ab9354d7fb 100644 --- a/website/docs/advanced/sso-saml.md +++ b/website/docs/how-to/how-to-add-sso-saml.md @@ -1,13 +1,16 @@ --- -id: sso-saml title: How to add SSO with SAML 2.0 Okta --- -> The **Single-Sign-On capability** is only available for customers on the Enterprise subscription. Check out the [Unleash plans](https://www.getunleash.io/plans) for details. +:::note Availability + +The **Single-Sign-On capability** is only available for customers on the Enterprise subscription. Check out the [Unleash plans](https://www.getunleash.io/plans) for details. + +::: ## Introduction {#introduction} -In this guide we will do a deep dive on the Single-Sign-On (SSO) integration with SAML 2.0 and connect it with Okta as IdP. Unleash support other identity providers and protocols, have a look at [all available Single-Sign-On options](./sso.md) +In this guide we will do a deep dive on the Single-Sign-On (SSO) integration with SAML 2.0 and connect it with Okta as IdP. Unleash support other identity providers and protocols, have a look at [all available Single-Sign-On options](../advanced/sso.md) ## Basic configuration diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 3d946d736a..be3703e42b 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -189,6 +189,22 @@ module.exports = { from: '/api/open_api', to: '/reference/api/unleash', }, + { + from: '/advanced/sso-google', + to: '/how-to/how-to-add-sso-google', + }, + { + from: '/advanced/sso-open-id-connect', + to: '/how-to/how-to-add-sso-open-id-connect', + }, + { + from: '/advanced/sso-saml-keycloak', + to: '/how-to/how-to-add-sso-saml-keycloak', + }, + { + from: '/advanced/sso-saml', + to: '/how-to/how-to-add-sso-saml', + }, ], createRedirects: function (toPath) { if ( diff --git a/website/sidebars.js b/website/sidebars.js index cbcf30f7b9..c0fd9b4196 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -132,10 +132,10 @@ module.exports = { { label: 'Single Sign-On (SSO)', items: [ - 'advanced/sso-open-id-connect', - 'advanced/sso-saml', - 'advanced/sso-saml-keycloak', - 'advanced/sso-google', + 'how-to/how-to-add-sso-open-id-connect', + 'how-to/how-to-add-sso-saml', + 'how-to/how-to-add-sso-saml-keycloak', + 'how-to/how-to-add-sso-google', 'how-to/how-to-setup-sso-keycloak-group-sync', ], type: 'category',