Skip to content

Commit 5984e57

Browse files
authored
Merge pull request #3049 from manics/jh-stable-docs
Use jupyterhub docs `stable` instead of `latest`
2 parents 8b6ca7d + 8de2d98 commit 5984e57

File tree

6 files changed

+10
-10
lines changed

6 files changed

+10
-10
lines changed

docs/source/administrator/authentication.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ authenticator class itself through this Helm chart's
3939
As all authenticator classes derive from the `Authenticator` base class, they
4040
share some configuration options. Below are some common configuration options,
4141
but please refer to the official [configuration
42-
reference](https://jupyterhub.readthedocs.io/en/latest/api/auth.html) for more
42+
reference](https://jupyterhub.readthedocs.io/en/stable/api/auth.html) for more
4343
details.
4444

45-
### [allowed_users](https://jupyterhub.readthedocs.io/en/latest/api/auth.html#jupyterhub.auth.Authenticator.allowed_users) / [admin_users](https://jupyterhub.readthedocs.io/en/latest/api/auth.html#jupyterhub.auth.LocalAuthenticator.admin_users)
45+
### [allowed_users](https://jupyterhub.readthedocs.io/en/stable/api/auth.html#jupyterhub.auth.Authenticator.allowed_users) / [admin_users](https://jupyterhub.readthedocs.io/en/stable/api/auth.html#jupyterhub.auth.LocalAuthenticator.admin_users)
4646

4747
Some authenticator classes may have dedicated logic in addition this this to
4848
authorize users.
@@ -70,7 +70,7 @@ In the above configuration, we have configured three things:
7070
2. anyone will be able to login with username `user1-4` and the password `a-shared-secret-password`
7171
3. `user1` and `user2` will have admin permissions, while `user3` and `user4` will be regular users.
7272

73-
### [auto_login](https://jupyterhub.readthedocs.io/en/latest/api/auth.html#jupyterhub.auth.Authenticator.auto_login)
73+
### [auto_login](https://jupyterhub.readthedocs.io/en/stable/api/auth.html#jupyterhub.auth.Authenticator.auto_login)
7474

7575
If you have configured authentication with GitHub for example, the page
7676
`/hub/login` will feature a single orange button that users are to press to
@@ -84,7 +84,7 @@ hub:
8484
auto_login: true
8585
```
8686

87-
### [enable_auth_state](https://jupyterhub.readthedocs.io/en/latest/api/auth.html#jupyterhub.auth.Authenticator.enable_auth_state)
87+
### [enable_auth_state](https://jupyterhub.readthedocs.io/en/stable/api/auth.html#jupyterhub.auth.Authenticator.enable_auth_state)
8888

8989
If you want JupyterHub to persist often sensitive information received as part
9090
of logging in, you need to enable it.
@@ -97,7 +97,7 @@ hub:
9797
```
9898

9999
For more information about authentication state, see [JupyterHub's own
100-
documentation](https://jupyterhub.readthedocs.io/en/latest/reference/authenticators.html#authentication-state)
100+
documentation](https://jupyterhub.readthedocs.io/en/stable/reference/authenticators.html#authentication-state)
101101
about authentication state.
102102

103103
````{note}

docs/source/administrator/upgrading/upgrade-1-to-2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ and the configuration reference entries under
5151

5252
Z2JH 2.0.0 upgrades from JupyterHub 1 directly to JupyterHub 3, and also upgrades all hub components.
5353
If you are using any custom JupyterHub services, addons, API integrations, or extra configuration, you should review the breaking changes in the
54-
major releases of JupyterHub 2 and 3 in the [JupyterHub changelog](https://jupyterhub.readthedocs.io/en/latest/changelog.html).
54+
major releases of JupyterHub 2 and 3 in the [JupyterHub changelog](https://jupyterhub.readthedocs.io/en/stable/changelog.html).
5555

5656
JupyterHub 2 and 3 updates the database schema, which means a migration takes place when you upgrade JupyterHub.
5757
Z2JH automatically handles the upgrade if you are using sqlite (`hub.db.type = 'sqlite-pvc'`, the default), but it may not be possible to downgrade to older releases after this.

docs/source/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ this list should be updated.
2121
images are upgraded as soon as practical, before or after the JupyterHub
2222
chart is upgraded. We expect running user servers to be able to keep running
2323
during the upgrade.
24-
- Changelog available at https://jupyterhub.readthedocs.io/en/latest/changelog.html
24+
- Changelog available at https://jupyterhub.readthedocs.io/en/stable/changelog.html
2525

2626
## 2.0
2727

docs/source/resources/glossary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ details.
1616
A user who can access the JupyterHub admin panel. They can start/stop user
1717
pods, and potentially access their notebooks.
1818
19-
[authenticator](https://jupyterhub.readthedocs.io/en/latest/reference/authenticators.html)
19+
[authenticator](https://jupyterhub.readthedocs.io/en/stable/reference/authenticators.html)
2020
The way in which users are authenticated to log into JupyterHub. There
2121
are many authenticators available, like GitHub, Google, MediaWiki,
2222
Dummy (anyone can log in), etc.

docs/source/resources/reference-docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Related Projects
44

5-
- The [JupyterHub Documentation](https://jupyterhub.readthedocs.io/en/latest/)
5+
- The [JupyterHub Documentation](https://jupyterhub.readthedocs.io/en/stable/)
66
provides information about JupyterHub itself (not the Kubernetes deployment).
77
- [Binder](https://mybinder.org) allows users to create sharable computational
88
environments on-the-fly. It makes heavy use of JupyterHub.

jupyterhub/schema.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1329,7 +1329,7 @@ properties:
13291329
permissions as defined in JupyterHub's RBAC system.
13301330
13311331
Complement this documentation with [JupyterHub's
1332-
documentation](https://jupyterhub.readthedocs.io/en/latest/rbac/roles.html#defining-roles)
1332+
documentation](https://jupyterhub.readthedocs.io/en/stable/rbac/roles.html#defining-roles)
13331333
about `load_roles`.
13341334
13351335
Note that while JupyterHub's native configuration `load_roles` accepts

0 commit comments

Comments
 (0)