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 <ch@bitfehler.net>
* fix: doc build instructions in docs/README.md
---------
Signed-off-by: Conrad Hoffmann <ch@bitfehler.net>
commit8afb047e01906a20d73f7578ef5d54b592e2a4ef
authorConrad Hoffmann <1226676+bitfehler@users.noreply.github.com>
dateWed 20 Aug 2025, 12:02 (1 year ago)
parent5082db0
docs/README.md+1−1
@@ -19,7 +19,7 @@ This command starts a local development server and open up a browser window. Mos
1919## Build
2020
2121```console
22−npm build
22+npm run build
2323```
2424
2525This command generates static content into the `build` directory and can be served using any static contents hosting service.
docs/docs/configuration/providers/index.md+1
@@ -25,6 +25,7 @@ Valid providers are :
2525- [Microsoft Entra ID](ms_entra_id.md)
2626- [Nextcloud](nextcloud.md)
2727- [OpenID Connect](openid_connect.md)
28+- [SourceHut](sourcehut.md)
2829
2930The 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).
3031
docs/docs/configuration/providers/sourcehut.md+1−1
@@ -21,5 +21,5 @@ to the appropriate URLs:
2121
2222The default configuration allows everyone with an account to authenticate.
2323Restricting access is currently only supported by
24−[email](#email-authentication).
24+[email](index.md#email-authentication).
2525
docs/sidebars.js+1
@@ -47,6 +47,7 @@ const sidebars = {
4747 "configuration/providers/ms_entra_id",
4848 "configuration/providers/nextcloud",
4949 "configuration/providers/openid_connect",
50+ "configuration/providers/sourcehut"
5051 ],
5152 },
5253 'configuration/session_storage',
docs/versioned_docs/version-7.11.x/configuration/providers/index.md+1
@@ -24,6 +24,7 @@ Valid providers are :
2424- [Microsoft Entra ID](ms_entra_id.md)
2525- [Nextcloud](nextcloud.md)
2626- [OpenID Connect](openid_connect.md)
27+- [SourceHut](sourcehut.md)
2728
2829The 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).
2930
docs/versioned_docs/version-7.11.x/configuration/providers/sourcehut.md+1−1
@@ -21,5 +21,5 @@ to the appropriate URLs:
2121
2222The default configuration allows everyone with an account to authenticate.
2323Restricting access is currently only supported by
24−[email](#email-authentication).
24+[email](index.md#email-authentication).
2525
docs/versioned_docs/version-7.12.x/configuration/providers/index.md+1
@@ -25,6 +25,7 @@ Valid providers are :
2525- [Microsoft Entra ID](ms_entra_id.md)
2626- [Nextcloud](nextcloud.md)
2727- [OpenID Connect](openid_connect.md)
28+- [SourceHut](sourcehut.md)
2829
2930The 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).
3031
docs/versioned_docs/version-7.12.x/configuration/providers/sourcehut.md+1−1
@@ -21,5 +21,5 @@ to the appropriate URLs:
2121
2222The default configuration allows everyone with an account to authenticate.
2323Restricting access is currently only supported by
24−[email](#email-authentication).
24+[email](index.md#email-authentication).
2525
docs/versioned_sidebars/version-7.11.x-sidebars.json+2−1
@@ -46,7 +46,8 @@
4646 "configuration/providers/login_gov",
4747 "configuration/providers/ms_entra_id",
4848 "configuration/providers/nextcloud",
49− "configuration/providers/openid_connect"
49+ "configuration/providers/openid_connect",
50+ "configuration/providers/sourcehut"
5051 ]
5152 },
5253 "configuration/session_storage",
docs/versioned_sidebars/version-7.12.x-sidebars.json+2−1
@@ -46,7 +46,8 @@
4646 "configuration/providers/login_gov",
4747 "configuration/providers/ms_entra_id",
4848 "configuration/providers/nextcloud",
49− "configuration/providers/openid_connect"
49+ "configuration/providers/openid_connect",
50+ "configuration/providers/sourcehut"
5051 ]
5152 },
5253 "configuration/session_storage",