habsi/authentik
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

website/docs: Prepare for monorepo. (#14119)

Browse Source 
* docusaurus-theme: Fix header alignment, overscroll, vertical padding.

* docusaurus-theme: Lint.

* website/docs: Prepare for monorepo packages.

* website/docs: Clean up dependencies. Tidy table.

* website/docs: Fix issue where Prettier affects example content.

* website/docs: Temp fix for stale packages.
This commit is contained in:
Teffen Ellis
2025-04-24 20:22:56 +02:00
committed by GitHub
parent ae41ccd862
commit 5bdef1c4f6
61 changed files with 5862 additions and 3857 deletions
Download Patch File Download Diff File Expand all files Collapse all files

114
website/sidebars.js
View File

@ -1,63 +1,38 @@
import { generateVersionDropdown } from "./src/utils.js";
/**
* @file Sidebar configuration for documentation entries.
*
* @todo Move releases into a JSON file.
* @todo Fix typescript import of `apiReference`.
*/
import apiReference from "./docs/developer-docs/api/reference/sidebar";
import { generateVersionDropdown } from "./src/utils.js";
import releases from "./static/releases.json" with { type: "json" };
const releases = [
"releases/2025/v2025.2",
"releases/2024/v2024.12",
"releases/2024/v2024.10",
{
const SUPPORTED_RELEASE_COUNT = 3;
// TODO: This logic is a placeholder for a more robust solution.
/**
* @type {any[]}
*/
const releaseEntries = [
// Grab the latest releases and add them to the sidebar.
...releases.slice(0, SUPPORTED_RELEASE_COUNT),
];
if (releases.length > SUPPORTED_RELEASE_COUNT) {
// Then we add the rest of the releases as a category.
releaseEntries.push({
type: "category",
label: "Previous versions",
items: [
"releases/2024/v2024.8",
"releases/2024/v2024.6",
"releases/2024/v2024.4",
"releases/2024/v2024.2",
"releases/2023/v2023.10",
"releases/2023/v2023.8",
"releases/2023/v2023.6",
"releases/2023/v2023.5",
"releases/2023/v2023.4",
"releases/2023/v2023.3",
"releases/2023/v2023.2",
"releases/2023/v2023.1",
"releases/2022/v2022.12",
"releases/2022/v2022.11",
"releases/2022/v2022.10",
"releases/2022/v2022.9",
"releases/2022/v2022.8",
"releases/2022/v2022.7",
"releases/2022/v2022.6",
"releases/2022/v2022.5",
"releases/2022/v2022.4",
"releases/2022/v2022.2",
"releases/2022/v2022.1",
"releases/2021/v2021.12",
"releases/2021/v2021.10",
"releases/2021/v2021.9",
"releases/2021/v2021.8",
"releases/2021/v2021.7",
"releases/2021/v2021.6",
"releases/2021/v2021.5",
"releases/2021/v2021.4",
"releases/2021/v2021.3",
"releases/2021/v2021.2",
"releases/2021/v2021.1",
"releases/old/v0.14",
"releases/old/v0.13",
"releases/old/v0.12",
"releases/old/v0.11",
"releases/old/v0.10",
"releases/old/v0.9",
],
},
];
items: releases.slice(SUPPORTED_RELEASE_COUNT),
});
}
export default {
docs: [
{
type: "html",
value: generateVersionDropdown(releases),
value: generateVersionDropdown(releases.slice(0, SUPPORTED_RELEASE_COUNT)),
},
{
type: "doc",
@ -147,10 +122,7 @@ export default {
type: "doc",
id: "add-secure-apps/providers/property-mappings/index",
},
items: [
"add-secure-apps/providers/property-mappings/expression",
,
],
items: ["add-secure-apps/providers/property-mappings/expression"],
},
{
type: "category",
@ -171,9 +143,7 @@ export default {
type: "doc",
id: "add-secure-apps/providers/ldap/index",
},
items: [
"add-secure-apps/providers/ldap/generic_setup",
],
items: ["add-secure-apps/providers/ldap/generic_setup"],
},
{
type: "category",
@ -246,9 +216,7 @@ export default {
type: "doc",
id: "add-secure-apps/providers/ssf/index",
},
items: [
"add-secure-apps/providers/ssf/create-ssf-provider",
],
items: ["add-secure-apps/providers/ssf/create-ssf-provider"],
},
],
},
@ -326,9 +294,7 @@ export default {
type: "doc",
id: "add-secure-apps/flows-stages/bindings/index",
},
items: [
"add-secure-apps/flows-stages/bindings/work_with_bindings",
],
items: ["add-secure-apps/flows-stages/bindings/work_with_bindings"],
},
],
},
@ -470,10 +436,7 @@ export default {
type: "doc",
id: "users-sources/groups/index",
},
items: [
"users-sources/groups/manage_groups",
"users-sources/groups/group_ref",
],
items: ["users-sources/groups/manage_groups", "users-sources/groups/group_ref"],
},
{
type: "category",
@ -517,9 +480,7 @@ export default {
type: "doc",
id: "users-sources/sources/protocols/kerberos/index",
},
items: [
"users-sources/sources/protocols/kerberos/browser",
],
items: ["users-sources/sources/protocols/kerberos/browser"],
},
"users-sources/sources/protocols/ldap/index",
"users-sources/sources/protocols/oauth/index",
@ -534,9 +495,7 @@ export default {
type: "doc",
id: "users-sources/sources/property-mappings/index",
},
items: [
"users-sources/sources/property-mappings/expressions",
],
items: ["users-sources/sources/property-mappings/expressions"],
},
{
type: "category",
@ -606,10 +565,7 @@ export default {
type: "doc",
id: "sys-mgmt/events/index",
},
items: [
"sys-mgmt/events/notifications",
"sys-mgmt/events/transports",
],
items: ["sys-mgmt/events/notifications", "sys-mgmt/events/transports"],
},
"sys-mgmt/certificates",
"sys-mgmt/settings",
@ -805,7 +761,7 @@ export default {
slug: "releases",
description: "Release Notes for recent authentik versions",
},
items: releases,
items: releaseEntries,
},
],
};