From 8afb047e01906a20d73f7578ef5d54b592e2a4ef Mon Sep 17 00:00:00 2001 From: Conrad Hoffmann <1226676+bitfehler@users.noreply.github.com> Date: Wed, 20 Aug 2025 12:02:32 +0200 Subject: [PATCH] doc: SourceHut documentation fixes (#3170) * fix: SourceHut documentation - Add it to sidebar and provider index - Fix broken link This fixes an oversight in #2359, where I had not fully understood how the documentation works. Signed-off-by: Conrad Hoffmann * fix: doc build instructions in docs/README.md --------- Signed-off-by: Conrad Hoffmann --- docs/README.md | 2 +- docs/docs/configuration/providers/index.md | 1 + docs/docs/configuration/providers/sourcehut.md | 2 +- docs/sidebars.js | 1 + .../version-7.11.x/configuration/providers/index.md | 1 + .../version-7.11.x/configuration/providers/sourcehut.md | 2 +- .../version-7.12.x/configuration/providers/index.md | 1 + .../version-7.12.x/configuration/providers/sourcehut.md | 2 +- docs/versioned_sidebars/version-7.11.x-sidebars.json | 3 ++- docs/versioned_sidebars/version-7.12.x-sidebars.json | 3 ++- 10 files changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/README.md b/docs/README.md index 349f3456..5aa1c060 100644 --- a/docs/README.md +++ b/docs/README.md @@ -19,7 +19,7 @@ This command starts a local development server and open up a browser window. Mos ## Build ```console -npm build +npm run build ``` This command generates static content into the `build` directory and can be served using any static contents hosting service. diff --git a/docs/docs/configuration/providers/index.md b/docs/docs/configuration/providers/index.md index 713b5cb9..3d3938ff 100644 --- a/docs/docs/configuration/providers/index.md +++ b/docs/docs/configuration/providers/index.md @@ -25,6 +25,7 @@ Valid providers are : - [Microsoft Entra ID](ms_entra_id.md) - [Nextcloud](nextcloud.md) - [OpenID Connect](openid_connect.md) +- [SourceHut](sourcehut.md) The provider can be selected using the `provider` configuration value, or set in the [`providers` array using AlphaConfig](https://oauth2-proxy.github.io/oauth2-proxy/configuration/alpha-config#providers). However, [**the feature to implement multiple providers is not complete**](https://github.com/oauth2-proxy/oauth2-proxy/issues/926). diff --git a/docs/docs/configuration/providers/sourcehut.md b/docs/docs/configuration/providers/sourcehut.md index 88d14622..2c196bda 100644 --- a/docs/docs/configuration/providers/sourcehut.md +++ b/docs/docs/configuration/providers/sourcehut.md @@ -21,5 +21,5 @@ to the appropriate URLs: The default configuration allows everyone with an account to authenticate. Restricting access is currently only supported by -[email](#email-authentication). +[email](index.md#email-authentication). diff --git a/docs/sidebars.js b/docs/sidebars.js index 3240e7df..0a1bf0b4 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -47,6 +47,7 @@ const sidebars = { "configuration/providers/ms_entra_id", "configuration/providers/nextcloud", "configuration/providers/openid_connect", + "configuration/providers/sourcehut" ], }, 'configuration/session_storage', diff --git a/docs/versioned_docs/version-7.11.x/configuration/providers/index.md b/docs/versioned_docs/version-7.11.x/configuration/providers/index.md index b947c09b..248e4380 100644 --- a/docs/versioned_docs/version-7.11.x/configuration/providers/index.md +++ b/docs/versioned_docs/version-7.11.x/configuration/providers/index.md @@ -24,6 +24,7 @@ Valid providers are : - [Microsoft Entra ID](ms_entra_id.md) - [Nextcloud](nextcloud.md) - [OpenID Connect](openid_connect.md) +- [SourceHut](sourcehut.md) The provider can be selected using the `provider` configuration value, or set in the [`providers` array using AlphaConfig](https://oauth2-proxy.github.io/oauth2-proxy/configuration/alpha-config#providers). However, [**the feature to implement multiple providers is not complete**](https://github.com/oauth2-proxy/oauth2-proxy/issues/926). diff --git a/docs/versioned_docs/version-7.11.x/configuration/providers/sourcehut.md b/docs/versioned_docs/version-7.11.x/configuration/providers/sourcehut.md index 88d14622..2c196bda 100644 --- a/docs/versioned_docs/version-7.11.x/configuration/providers/sourcehut.md +++ b/docs/versioned_docs/version-7.11.x/configuration/providers/sourcehut.md @@ -21,5 +21,5 @@ to the appropriate URLs: The default configuration allows everyone with an account to authenticate. Restricting access is currently only supported by -[email](#email-authentication). +[email](index.md#email-authentication). diff --git a/docs/versioned_docs/version-7.12.x/configuration/providers/index.md b/docs/versioned_docs/version-7.12.x/configuration/providers/index.md index 713b5cb9..3d3938ff 100644 --- a/docs/versioned_docs/version-7.12.x/configuration/providers/index.md +++ b/docs/versioned_docs/version-7.12.x/configuration/providers/index.md @@ -25,6 +25,7 @@ Valid providers are : - [Microsoft Entra ID](ms_entra_id.md) - [Nextcloud](nextcloud.md) - [OpenID Connect](openid_connect.md) +- [SourceHut](sourcehut.md) The provider can be selected using the `provider` configuration value, or set in the [`providers` array using AlphaConfig](https://oauth2-proxy.github.io/oauth2-proxy/configuration/alpha-config#providers). However, [**the feature to implement multiple providers is not complete**](https://github.com/oauth2-proxy/oauth2-proxy/issues/926). diff --git a/docs/versioned_docs/version-7.12.x/configuration/providers/sourcehut.md b/docs/versioned_docs/version-7.12.x/configuration/providers/sourcehut.md index 88d14622..2c196bda 100644 --- a/docs/versioned_docs/version-7.12.x/configuration/providers/sourcehut.md +++ b/docs/versioned_docs/version-7.12.x/configuration/providers/sourcehut.md @@ -21,5 +21,5 @@ to the appropriate URLs: The default configuration allows everyone with an account to authenticate. Restricting access is currently only supported by -[email](#email-authentication). +[email](index.md#email-authentication). diff --git a/docs/versioned_sidebars/version-7.11.x-sidebars.json b/docs/versioned_sidebars/version-7.11.x-sidebars.json index 0dbf04bd..3f5eb854 100644 --- a/docs/versioned_sidebars/version-7.11.x-sidebars.json +++ b/docs/versioned_sidebars/version-7.11.x-sidebars.json @@ -46,7 +46,8 @@ "configuration/providers/login_gov", "configuration/providers/ms_entra_id", "configuration/providers/nextcloud", - "configuration/providers/openid_connect" + "configuration/providers/openid_connect", + "configuration/providers/sourcehut" ] }, "configuration/session_storage", diff --git a/docs/versioned_sidebars/version-7.12.x-sidebars.json b/docs/versioned_sidebars/version-7.12.x-sidebars.json index 0dbf04bd..3f5eb854 100644 --- a/docs/versioned_sidebars/version-7.12.x-sidebars.json +++ b/docs/versioned_sidebars/version-7.12.x-sidebars.json @@ -46,7 +46,8 @@ "configuration/providers/login_gov", "configuration/providers/ms_entra_id", "configuration/providers/nextcloud", - "configuration/providers/openid_connect" + "configuration/providers/openid_connect", + "configuration/providers/sourcehut" ] }, "configuration/session_storage",