From a9d6e92873f0affd6881a4591fc962192f0ea09d Mon Sep 17 00:00:00 2001 From: mffap Date: Thu, 20 Apr 2023 17:04:40 +0200 Subject: [PATCH] docs(integrate): create automatic overviews, move brokering (#5721) * overviews in sidebars * move identity brokering to features * fix links --- .../apis/actions/external-authentication.md | 2 +- .../features/identity-brokering.md} | 2 +- .../manage/console/instance-settings.mdx | 3 +- docs/docs/guides/manage/customize/behavior.md | 2 +- .../solution-scenarios/configurations.mdx | 2 +- docs/sidebars.js | 28 +++++++++++++++++-- 6 files changed, 31 insertions(+), 8 deletions(-) rename docs/docs/{guides/integrate/identity-providers/introduction.md => concepts/features/identity-brokering.md} (92%) diff --git a/docs/docs/apis/actions/external-authentication.md b/docs/docs/apis/actions/external-authentication.md index 294a99cad..f26f55af8 100644 --- a/docs/docs/apis/actions/external-authentication.md +++ b/docs/docs/apis/actions/external-authentication.md @@ -2,7 +2,7 @@ title: External Authentication Flow --- -This flow is executed if the user logs in using an [identity provider](/guides/integrate/identity-providers/introduction.md) or using a [jwt token](/concepts/structure/jwt_idp). +This flow is executed if the user logs in using an [identity provider](/guides/integrate/identity-providers) or using a [jwt token](/concepts/structure/jwt_idp). ## Post Authentication diff --git a/docs/docs/guides/integrate/identity-providers/introduction.md b/docs/docs/concepts/features/identity-brokering.md similarity index 92% rename from docs/docs/guides/integrate/identity-providers/introduction.md rename to docs/docs/concepts/features/identity-brokering.md index aa004511e..9b6c98f58 100644 --- a/docs/docs/guides/integrate/identity-providers/introduction.md +++ b/docs/docs/concepts/features/identity-brokering.md @@ -18,5 +18,5 @@ For example, if Google is configured as an identity provider in your organizatio Configure external identity providers on the instance level or just for one organization via the [Console](/guides/manage/console/instance-settings#identity-providers) or ZITADEL APIs. -The guides listed in this section will help you set up specific identity providers. +You will find [detailed integration guides for many Identity Providers](/guides/integrate/identity-providers) in our docs. ZITADEL also provides templates to configure generic identity providers, which don't have templates. diff --git a/docs/docs/guides/manage/console/instance-settings.mdx b/docs/docs/guides/manage/console/instance-settings.mdx index 147236510..5a66e68b6 100644 --- a/docs/docs/guides/manage/console/instance-settings.mdx +++ b/docs/docs/guides/manage/console/instance-settings.mdx @@ -141,8 +141,7 @@ Configure the different lifetimes checks for the login process: You can configure all kinds of external identity providers for identity brokering, which support OIDC (OpenID Connect). Create a new identity provider configuration and enable it in the list afterwards. -For a detailed guide about how to configure a new identity provider for identity brokering have a look at our guide: -[Identity Brokering](/guides/integrate/identity-providers/introduction.md) +For a detailed guide about how to configure a new identity provider for identity brokering have a look at our [identity provider guides](/guides/integrate/identity-providers). ## Password Complexity diff --git a/docs/docs/guides/manage/customize/behavior.md b/docs/docs/guides/manage/customize/behavior.md index 061ac9ef0..fc45f9305 100644 --- a/docs/docs/guides/manage/customize/behavior.md +++ b/docs/docs/guides/manage/customize/behavior.md @@ -11,7 +11,7 @@ Before you start, make sure you have everything set up correctly. - You need to be at least a ZITADEL _ORG_OWNER_ - Your ZITADEL organization needs to have the actions feature enabled. -- [Your ZITADEL organization needs to have at least one external identity provider enabled](../../integrate/identity-providers/introduction.md) +- [Your ZITADEL organization needs to have at least one external identity provider enabled](../../integrate/identity-providers) - [You need to have at least one role configured for a project](../console/projects) ## Copy some information for the action diff --git a/docs/docs/guides/solution-scenarios/configurations.mdx b/docs/docs/guides/solution-scenarios/configurations.mdx index f5a11b445..60953f61e 100644 --- a/docs/docs/guides/solution-scenarios/configurations.mdx +++ b/docs/docs/guides/solution-scenarios/configurations.mdx @@ -15,7 +15,7 @@ If a user of this organization wants to login, you don't want them to enter thei ### Settings 1. Go to the "Identity Providers" Settings of the organization -2. Configure the needed identity provider: Read this [guide](../integrate/identity-providers/introduction.md) if you don't know how +2. Configure the needed identity provider: Read this [guide](../integrate/identity-providers) if you don't know how 3. Go to the "Login Behavior and Security" settings of the organization 4. Disable "Username Password Allowed" and enable "External IDP allowed" in the Advanced Section diff --git a/docs/sidebars.js b/docs/sidebars.js index b967f0183..732e5a8f2 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -141,9 +141,16 @@ module.exports = { { type: "category", label: "Configure Identity Providers", + link: { + type: "generated-index", + title: "Let users login with their preferred identity provider", + slug: "/guides/integrate/identity-providers", + description: + "In the following guides you will learn how to configure and setup your preferred external identity provider in ZITADEL.", + + }, collapsed: true, items: [ - "guides/integrate/identity-providers/introduction", "guides/integrate/identity-providers/google", "guides/integrate/identity-providers/azure-ad", "guides/integrate/identity-providers/github", @@ -186,6 +193,14 @@ module.exports = { { type: "category", label: "Services", + link: { + type: "generated-index", + title: "Integrate ZITADEL with your favorite services", + slug: "/guides/integrate/services", + description: + "With the guides in this section you will learn how to integrate ZITADEL with your services.", + + }, collapsed: true, items: [ "guides/integrate/services/gitlab-self-hosted", @@ -200,6 +215,14 @@ module.exports = { { type: "category", label: "Tools", + link: { + type: "generated-index", + title: "Integrate ZITADEL with your tools", + slug: "/guides/integrate/tools", + description: + "With the guides in this section you will learn how to integrate ZITADEL with your favorite tools.", + + }, collapsed: true, items: [ "guides/integrate/authenticated-mongodb-charts", @@ -234,6 +257,7 @@ module.exports = { "concepts/structure/users", "concepts/structure/managers", "concepts/structure/policies", + "concepts/features/identity-brokering", "concepts/structure/jwt_idp", "concepts/features/actions", "concepts/features/selfservice", @@ -472,4 +496,4 @@ module.exports = { ], }, ], -}; +}; \ No newline at end of file