From bb1b8ab7bb64ae66912ac706bc67d2be4029eb78 Mon Sep 17 00:00:00 2001 From: Tana M Berry Date: Tue, 7 May 2024 11:59:25 -0500 Subject: [PATCH] website/docs: refine intro page for sources (#9625) --- website/developer-docs/docs/templates/index.md | 2 +- website/docs/sources/apple/index.md | 2 +- website/docs/sources/azure-ad/index.md | 2 +- website/docs/sources/discord/index.md | 2 +- website/docs/sources/github/index.md | 2 +- website/docs/sources/google/index.md | 2 +- website/docs/sources/{general.md => index.md} | 16 +++++++++++++--- website/docs/sources/mailcow/index.md | 2 +- website/docs/sources/plex/index.md | 2 +- website/docs/sources/twitch/index.md | 2 +- website/docs/sources/twitter/index.md | 2 +- website/integrations/index.mdx | 2 +- website/sidebars.js | 2 +- 13 files changed, 25 insertions(+), 15 deletions(-) rename website/docs/sources/{general.md => index.md} (56%) diff --git a/website/developer-docs/docs/templates/index.md b/website/developer-docs/docs/templates/index.md index 7f157a2840..d3e7491680 100644 --- a/website/developer-docs/docs/templates/index.md +++ b/website/developer-docs/docs/templates/index.md @@ -16,7 +16,7 @@ The most common types are: ### Add a new integration -To add documentation for a new integration (with support level Community or Vendor), please use the integration template [`service.md`](https://github.com/goauthentik/authentik/blob/main/website/integrations/_template/service.md) file from our GitHub repo. You can download the template file using the following command: +To add documentation for a new integration (with support level Community or Vendor), please use the integration templates [`service.md`](https://github.com/goauthentik/authentik/blob/main/website/integrations/_template/service.md) from our GitHub repo. You can download the template using the following command: ```shell wget https://raw.githubusercontent.com/goauthentik/authentik/main/website/integrations/_template/service.md diff --git a/website/docs/sources/apple/index.md b/website/docs/sources/apple/index.md index a2120f65ed..29744e33f2 100644 --- a/website/docs/sources/apple/index.md +++ b/website/docs/sources/apple/index.md @@ -69,5 +69,5 @@ The following placeholders will be used: Save, and you now have Apple as a source. :::note -For more details on how-to have the new source display on the Login Page see [here](../general#add-sources-to-default-login-page). +For more details on how-to have the new source display on the Login Page see [here](../index.md#add-sources-to-default-login-page). ::: diff --git a/website/docs/sources/azure-ad/index.md b/website/docs/sources/azure-ad/index.md index d9cacbdd60..5530d0c523 100644 --- a/website/docs/sources/azure-ad/index.md +++ b/website/docs/sources/azure-ad/index.md @@ -47,7 +47,7 @@ If you kept the default _Supported account types_ selection of _Single tenant_, Save, and you now have Azure AD as a source. :::note -For more details on how-to have the new source display on the Login Page see [here](../general#add-sources-to-default-login-page). +For more details on how-to have the new source display on the Login Page see [here](../index.md#add-sources-to-default-login-page). ::: ### Automatic user enrollment and attribute mapping diff --git a/website/docs/sources/discord/index.md b/website/docs/sources/discord/index.md index 1f673040df..bcdd7adb2c 100644 --- a/website/docs/sources/discord/index.md +++ b/website/docs/sources/discord/index.md @@ -50,7 +50,7 @@ Here is an example of a complete authentik Discord OAuth Source Save, and you now have Discord as a source. :::note -For more details on how-to have the new source display on the Login Page see [here](../general#add-sources-to-default-login-page). +For more details on how-to have the new source display on the Login Page see [here](../index.md#add-sources-to-default-login-page). ::: ### Checking for membership of a Discord Guild diff --git a/website/docs/sources/github/index.md b/website/docs/sources/github/index.md index 3b4e5978ea..cf84d71a91 100644 --- a/website/docs/sources/github/index.md +++ b/website/docs/sources/github/index.md @@ -47,7 +47,7 @@ Here is an example of a complete authentik Github OAuth Source Save, and you now have Github as a source. :::note -For more details on how-to have the new source display on the Login Page see [here](../general#add-sources-to-default-login-page). +For more details on how-to have the new source display on the Login Page see [here](../index.md#add-sources-to-default-login-page). ::: ### Checking for membership of a GitHub Organisation diff --git a/website/docs/sources/google/index.md b/website/docs/sources/google/index.md index 0dc442e2a2..8fd9557b20 100644 --- a/website/docs/sources/google/index.md +++ b/website/docs/sources/google/index.md @@ -79,7 +79,7 @@ Here is an example of a complete authentik Google OAuth Source Save, and you now have Google as a source. :::note -For more details on how-to have the new source display on the Login Page see [here](../general#add-sources-to-default-login-page). +For more details on how-to have the new source display on the Login Page see [here](../index.md#add-sources-to-default-login-page). ::: ## Username mapping diff --git a/website/docs/sources/general.md b/website/docs/sources/index.md similarity index 56% rename from website/docs/sources/general.md rename to website/docs/sources/index.md index 3f76be7add..6fefa3f7e6 100644 --- a/website/docs/sources/general.md +++ b/website/docs/sources/index.md @@ -1,13 +1,23 @@ --- -title: Overview of sources -slug: general +title: Sources +slug: /sources --- Sources allow you to connect authentik to an external user directory. Sources can also be used with social login providers such as Facebook, Twitter, or GitHub. +### Find your source + +Sources are in three general categories: + +- **Directory synchronization** (Active Directory, FreeIPA) +- **Protocols** (LDAP, OAuth, SAML, and SCIM) +- **Social logins** (Apple, Discord, Twitch, Twitter, and many others) + +For instructions to add a specific source, refer to the documentation links in the left navigation pane. + ### Add Sources to Default Login Page -To have sources show on the default login screen you will need to add them. The process below assumes that you have not created or renamed the default stages and flows. +To have sources show on the default login screen you will need to add them to the flow. The process below assumes that you have not created or renamed the default stages and flows. 1. In the Admin interface, navigate to the **Flows** section. 2. Click on **default-authentication-flow**. diff --git a/website/docs/sources/mailcow/index.md b/website/docs/sources/mailcow/index.md index edcade2dd2..baffde79c8 100644 --- a/website/docs/sources/mailcow/index.md +++ b/website/docs/sources/mailcow/index.md @@ -50,5 +50,5 @@ Here is an example of a complete authentik Mailcow OAuth Source Save, and you now have Mailcow as a source. :::note -For more details on how-to have the new source display on the Login Page see [here](../general#add-sources-to-default-login-page). +For more details on how-to have the new source display on the Login Page see [here](../index.md#add-sources-to-default-login-page). ::: diff --git a/website/docs/sources/plex/index.md b/website/docs/sources/plex/index.md index 088b8d75a2..590f9df4d6 100644 --- a/website/docs/sources/plex/index.md +++ b/website/docs/sources/plex/index.md @@ -23,5 +23,5 @@ Add _Plex_ as a _source_ Save, and you now have Plex as a source. :::note -For more details on how-to have the new source display on the Login Page see [here](../general#add-sources-to-default-login-page). +For more details on how-to have the new source display on the Login Page see [here](../index.md#add-sources-to-default-login-page). ::: diff --git a/website/docs/sources/twitch/index.md b/website/docs/sources/twitch/index.md index 7d4bc9b56b..577bc973c1 100644 --- a/website/docs/sources/twitch/index.md +++ b/website/docs/sources/twitch/index.md @@ -56,5 +56,5 @@ Here is an example of a complete authentik Twitch OAuth Source Save, and you now have Twitch as a source. :::note -For more details on how-to have the new source display on the Login Page see [here](../general#add-sources-to-default-login-page). +For more details on how-to have the new source display on the Login Page see [here](../index.md#add-sources-to-default-login-page). ::: diff --git a/website/docs/sources/twitter/index.md b/website/docs/sources/twitter/index.md index 8adca1344d..e6b778836f 100644 --- a/website/docs/sources/twitter/index.md +++ b/website/docs/sources/twitter/index.md @@ -44,5 +44,5 @@ You will need to create a new project, and OAuth credentials in the Twitter Deve 5. **Consumer Secret:** Your Client Secret from step 25 :::note -For more details on how-to have the new source display on the Login Page see [here](../general#add-sources-to-default-login-page). +For more details on how-to have the new source display on the Login Page see [here](../index.md#add-sources-to-default-login-page). ::: diff --git a/website/integrations/index.mdx b/website/integrations/index.mdx index 1dfed13acc..acb13d7d88 100644 --- a/website/integrations/index.mdx +++ b/website/integrations/index.mdx @@ -15,6 +15,6 @@ authentik integrates with many applications. For a full list, and to learn more In addition to applications, authentik also integrates with external sources, including federated directories like Active Directory and through protocols such as LDAP, OAuth, SAML, and SCIM sources. Sources are a way for authentik to use external credentials for authentication and verification. Sources in authentik can also be used for social logins, using external providers such as Facebook, Twitter, etc. -To learn more, refer to the [Sources](../docs/sources/general) documentation. +To learn more, refer to the [Sources](../docs/sources) documentation. ![](./sources-logo.png) diff --git a/website/sidebars.js b/website/sidebars.js index 0d49e707f5..4e0af9698b 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -141,7 +141,7 @@ const docsSidebar = { collapsed: true, link: { type: "doc", - id: "sources/general", + id: "sources/index", }, items: [ {