From e17f7020e6b46b8fbe2a9d618918658fa7e98104 Mon Sep 17 00:00:00 2001 From: Jens L Date: Wed, 15 Jun 2022 20:56:27 +0200 Subject: [PATCH] webiste/docs: use autogenerated pages and categories (#3102) Signed-off-by: Jens Langhammer --- website/docs/installation/index.md | 7 - .../providers/proxy/{proxy.md => index.md} | 0 website/integrations/index.md | 6 - .../sources/{index.md => general.md} | 3 +- website/sidebars.js | 72 +++++-- website/sidebarsIntegrations.js | 175 ++++++++++++------ 6 files changed, 177 insertions(+), 86 deletions(-) delete mode 100644 website/docs/installation/index.md rename website/docs/providers/proxy/{proxy.md => index.md} (100%) delete mode 100644 website/integrations/index.md rename website/integrations/sources/{index.md => general.md} (96%) diff --git a/website/docs/installation/index.md b/website/docs/installation/index.md deleted file mode 100644 index 289e061a7..000000000 --- a/website/docs/installation/index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Installation ---- - -If you want to try out authentik, or only want a small deployment you should use [docker-compose](./docker-compose). - -If you want a larger deployment, or you want High-Availability, you should use [Kubernetes](./kubernetes). diff --git a/website/docs/providers/proxy/proxy.md b/website/docs/providers/proxy/index.md similarity index 100% rename from website/docs/providers/proxy/proxy.md rename to website/docs/providers/proxy/index.md diff --git a/website/integrations/index.md b/website/integrations/index.md deleted file mode 100644 index dbada61c0..000000000 --- a/website/integrations/index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Integrations -slug: / ---- - -Here you can find a full list of applications that have been documented to work with authentik. If you find any mistake or a step does not work for you, open a GitHub issue [here](https://github.com/goauthentik/authentik/issues/new/choose). diff --git a/website/integrations/sources/index.md b/website/integrations/sources/general.md similarity index 96% rename from website/integrations/sources/index.md rename to website/integrations/sources/general.md index 778bf3799..f42b60433 100644 --- a/website/integrations/sources/index.md +++ b/website/integrations/sources/general.md @@ -1,5 +1,6 @@ --- -title: Overview +title: General +slug: general --- Sources allow you to connect authentik to an existing user directory. They can also be used for social logins, using external providers such as Facebook, Twitter, etc. diff --git a/website/sidebars.js b/website/sidebars.js index cf4e1030a..e693eb78d 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -7,8 +7,14 @@ module.exports = { { type: "category", label: "Installation", + link: { + type: "generated-index", + title: "Installation", + slug: "installation", + description: + "Everything you need to get authentik up and running!", + }, items: [ - "installation/index", "installation/docker-compose", "installation/kubernetes", "installation/beta", @@ -36,17 +42,21 @@ module.exports = { { type: "category", label: "OAuth2 Provider", - items: [ - "providers/oauth2/index", - "providers/oauth2/client_credentials", - ], + link: { + type: "doc", + id: "providers/oauth2/index", + }, + items: ["providers/oauth2/client_credentials"], }, "providers/saml", { type: "category", label: "Proxy Provider", + link: { + type: "doc", + id: "providers/proxy/index", + }, items: [ - "providers/proxy/proxy", "providers/proxy/custom_headers", "providers/proxy/forward_auth", ], @@ -57,8 +67,11 @@ module.exports = { { type: "category", label: "Outposts", + link: { + type: "doc", + id: "outposts/index", + }, items: [ - "outposts/index", "outposts/embedded/embedded", { type: "category", @@ -82,8 +95,11 @@ module.exports = { { type: "category", label: "Flows", + link: { + type: "doc", + id: "flow/index", + }, items: [ - "flow/index", "flow/layouts", "flow/inspector", "flow/examples", @@ -101,6 +117,12 @@ module.exports = { { type: "category", label: "Stages", + link: { + type: "generated-index", + title: "Stages", + slug: "flow/stages", + description: "Overview of all available stages", + }, items: [ "flow/stages/authenticator_duo/index", "flow/stages/authenticator_sms/index", @@ -124,21 +146,29 @@ module.exports = { { type: "category", label: "Policies", - items: ["policies/index", "policies/expression"], + link: { + type: "doc", + id: "policies/index", + }, + items: ["policies/expression"], }, { type: "category", label: "Property Mappings", - items: ["property-mappings/index", "property-mappings/expression"], + link: { + type: "doc", + id: "property-mappings/index", + }, + items: ["property-mappings/expression"], }, { type: "category", label: "Events", - items: [ - "events/index", - "events/notifications", - "events/transports", - ], + link: { + type: "doc", + id: "events/index", + }, + items: ["events/notifications", "events/transports"], }, { type: "category", @@ -164,6 +194,12 @@ module.exports = { { type: "category", label: "Release Notes", + link: { + type: "generated-index", + title: "Releases", + slug: "releases", + description: "Release notes for recent authentik versions", + }, items: [ "releases/v2022.6", "releases/v2022.5", @@ -198,6 +234,12 @@ module.exports = { { type: "category", label: "Troubleshooting", + link: { + type: "generated-index", + title: "Troubleshooting", + slug: "troubleshooting", + description: "Troubleshooting various issues", + }, items: [ "troubleshooting/access", "troubleshooting/emails", diff --git a/website/sidebarsIntegrations.js b/website/sidebarsIntegrations.js index 889d57d81..b3a937a61 100644 --- a/website/sidebarsIntegrations.js +++ b/website/sidebarsIntegrations.js @@ -1,76 +1,137 @@ module.exports = { integrations: [ - { - type: "doc", - id: "index", - }, { type: "category", label: "Applications", + link: { + type: "generated-index", + title: "Applications", + slug: "/", + description: "Applications which integrate with authentik", + }, items: [ - "services/apache-guacamole/index", - "services/aws/index", - "services/awx-tower/index", - "services/bookstack/index", - "services/budibase/index", - "services/fortimanager/index", - "services/gitea/index", - "services/gitlab/index", - "services/grafana/index", - "services/harbor/index", - "services/hashicorp-vault/index", - "services/hedgedoc/index", + { + type: "category", + label: "Monitoring & Infarstructure", + items: [ + { + type: "category", + label: "Hypervisors / Orchestrators", + items: [ + "services/portainer/index", + "services/proxmox-ve/index", + "services/rancher/index", + "services/vmware-vcenter/index", + ], + }, + { + type: "category", + label: "Monitoring", + items: [ + "services/grafana/index", + "services/ubuntu-landscape/index", + "services/uptime-kuma/index", + "services/zabbix/index", + ], + }, + "services/apache-guacamole/index", + "services/awx-tower/index", + "services/fortimanager/index", + "services/harbor/index", + "services/hashicorp-vault/index", + "services/minio/index", + "services/opnsense/index", + "services/pfsense/index", + "services/pgadmin/index", + "services/powerdns-admin/index", + "services/veeam-enterprise-manager/index", + ], + }, + { + type: "category", + label: "Cloud Providers", + items: ["services/aws/index"], + }, + { + type: "category", + label: "Chat, Communication & Collaboration", + items: [ + "services/bookstack/index", + "services/hedgedoc/index", + "services/matrix-synapse/index", + "services/nextcloud/index", + "services/onlyoffice/index", + "services/paperless-ng/index", + "services/rocketchat/index", + "services/roundcube/index", + "services/vikunja/index", + "services/wekan/index", + "services/wiki-js/index", + "services/zulip/index", + ], + }, + { + type: "category", + label: "Platforms", + items: [ + "services/budibase/index", + "services/wordpress/index", + ], + }, + { + type: "category", + label: "Developer tools", + items: [ + "services/gitea/index", + "services/gitlab/index", + "services/sentry/index", + "services/sssd/index", + "services/weblate/index", + ], + }, "services/home-assistant/index", "services/kimai/index", - "services/matrix-synapse/index", - "services/minio/index", - "services/nextcloud/index", - "services/onlyoffice/index", - "services/opnsense/index", - "services/paperless-ng/index", - "services/pfsense/index", - "services/pgadmin/index", - "services/portainer/index", - "services/powerdns-admin/index", - "services/proxmox-ve/index", - "services/rancher/index", - "services/rocketchat/index", - "services/roundcube/index", - "services/sentry/index", "services/sonarr/index", - "services/sssd/index", "services/tautulli/index", - "services/ubuntu-landscape/index", - "services/uptime-kuma/index", - "services/veeam-enterprise-manager/index", - "services/vikunja/index", - "services/vmware-vcenter/index", - "services/weblate/index", - "services/wekan/index", - "services/wiki-js/index", - "services/wordpress/index", - "services/zabbix/index", - "services/zulip/index", ], }, { type: "category", label: "Federation & Social login", + link: { + type: "generated-index", + title: "Sources", + slug: "sources", + description: + "Sources of users which can be federated with authentik", + }, items: [ - "sources/index", - "sources/active-directory/index", - "sources/apple/index", - "sources/azure-ad/index", - "sources/discord/index", - "sources/freeipa/index", - "sources/github/index", - "sources/google/index", - "sources/ldap/index", - "sources/mailcow/index", - "sources/oauth/index", - "sources/plex/index", - "sources/saml/index", - "sources/twitter/index", + "sources/general", + { + type: "category", + label: "Social Logins", + items: [ + "sources/apple/index", + "sources/azure-ad/index", + "sources/discord/index", + "sources/github/index", + "sources/google/index", + "sources/mailcow/index", + "sources/oauth/index", + "sources/plex/index", + "sources/saml/index", + "sources/twitter/index", + ], + }, + { + type: "category", + label: "Directory syncronization", + items: [ + "sources/active-directory/index", + "sources/freeipa/index", + "sources/ldap/index", + ], + }, ], }, ],