mirror of
https://github.com/jupyterhub/jupyterhub.git
synced 2025-10-07 18:14:10 +00:00
Provide consistent myst references to documentation pages
While doing https://github.com/jupyterhub/jupyterhub/pull/2726, I realized we don't have a consistent way to format references inside the docs. I now have them be formatted to match the name of the file, but using `:` to separate them instead of `/` or `-`. `/` makes it ambiguous when using with markdown link syntax, as it could be a reference or a file. And using `-` is ambiguous, as that can be the name of the file itself. This PR does about half, I can do the other half later (unless someone else does).
This commit is contained in:
@@ -11,7 +11,7 @@
|
||||
:Release: {{ version }}
|
||||
|
||||
JupyterHub also provides a REST API for administration of the Hub and users.
|
||||
The documentation on [Using JupyterHub's REST API](using-jupyterhub-rest-api) provides
|
||||
The documentation on [Using JupyterHub's REST API](howto:rest-api) provides
|
||||
information on:
|
||||
|
||||
- what you can do with the API
|
||||
|
@@ -27,7 +27,7 @@ Contributors to major version bumps in JupyterHub include:
|
||||
5.0.0 is a major release of JupyterHub.
|
||||
It has lots of cool new features.
|
||||
|
||||
For information about upgrading, see [upgrading to 5.0 documentation](upgrading-v5).
|
||||
For information about upgrading, see [upgrading to 5.0 documentation](howto:upgrading-v5).
|
||||
|
||||
Changes that are likely to require effort to upgrade:
|
||||
|
||||
@@ -298,7 +298,7 @@ especially those with other user content on peer domains to JupyterHub.
|
||||
|
||||
As always, JupyterHub deployments are especially encouraged to enable per-user domains if protecting users from each other is a concern.
|
||||
|
||||
For more information on securely deploying JupyterHub, see the [web security documentation](web-security).
|
||||
For more information on securely deploying JupyterHub, see the [web security documentation](explanation:security).
|
||||
|
||||
[CVE-2024-28233]: https://github.com/jupyterhub/jupyterhub/security/advisories/GHSA-7r3h-4ph8-w38g
|
||||
|
||||
@@ -422,13 +422,13 @@ See [our definition of contributors](https://github-activity.readthedocs.io/en/l
|
||||
:::{admonition} Upgrade note
|
||||
|
||||
Upgrading from 3.1 to 4.0 should require no additional action beyond running `jupyterhub --upgrade-db` to upgrade the database schema after upgrading the package version.
|
||||
It is otherwise a regular jupyterhub [upgrade](upgrading-jupyterhub).
|
||||
It is otherwise a regular jupyterhub [upgrade](howto:upgrading-jupyterhub).
|
||||
:::
|
||||
|
||||
There are three major changes that _should_ be invisible to most users:
|
||||
|
||||
1. Groups can now have 'properties', editable via the admin page, which can be used by Spawners for their operations.
|
||||
This requires a db schema upgrade, so remember to [**backup and upgrade your database**](upgrading-jupyterhub)!
|
||||
This requires a db schema upgrade, so remember to [**backup and upgrade your database**](howto:upgrading-jupyterhub)!
|
||||
2. Often-problematic header-based checks for cross-site requests have been replaces with more standard use of XSRF tokens.
|
||||
Most folks shouldn't notice this change, but if "Blocking Cross Origin API request" has been giving you headaches, this should be much improved.
|
||||
3. Improved support for Jupyter Server 2.0 by reimplementing `jupyterhub-singleuser` as a standard _server extension_.
|
||||
@@ -1136,7 +1136,7 @@ and consider assigning only the necessary roles and scopes.
|
||||
[rbac]: ./rbac/index.md
|
||||
|
||||
JupyterHub 2.0 requires an update to the database schema,
|
||||
so **make sure to [read the upgrade documentation and backup your database](upgrading-jupyterhub)
|
||||
so **make sure to [read the upgrade documentation and backup your database](howto:upgrading-jupyterhub)
|
||||
before upgrading**.
|
||||
|
||||
:::{admonition} stop all servers before upgrading
|
||||
|
@@ -213,7 +213,7 @@ c.JupyterHub.load_roles = [
|
||||
]
|
||||
```
|
||||
|
||||
When a service has a configured URL or explicit `oauth_client_id` or `oauth_redirect_uri`, it can operate as an [OAuth client](jupyterhub-oauth).
|
||||
When a service has a configured URL or explicit `oauth_client_id` or `oauth_redirect_uri`, it can operate as an [OAuth client](explanation:hub-oauth).
|
||||
When a user visits an oauth-authenticated service,
|
||||
completion of authentication results in issuing an oauth token.
|
||||
|
||||
|
@@ -4,7 +4,7 @@
|
||||
|
||||
This document describes how JupyterHub routes requests.
|
||||
|
||||
This does not include the [REST API](using-jupyterhub-rest-api) URLs.
|
||||
This does not include the [REST API](howto:rest-api) URLs.
|
||||
|
||||
In general, all URLs can be prefixed with `c.JupyterHub.base_url` to
|
||||
run the whole JupyterHub application on a prefix.
|
||||
@@ -240,7 +240,7 @@ and the page will show a link back to `/hub/spawn/...`.
|
||||
|
||||
On this page, users can manage their JupyterHub API tokens.
|
||||
They can revoke access and request new tokens for writing scripts
|
||||
against the [JupyterHub REST API](using-jupyterhub-rest-api).
|
||||
against the [JupyterHub REST API](howto:rest-api).
|
||||
|
||||
## `/hub/admin`
|
||||
|
||||
|
Reference in New Issue
Block a user