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:
YuviPanda
2024-06-10 19:11:51 -07:00
parent 4c868cdfb6
commit 3a9c631526
39 changed files with 67 additions and 33 deletions

View File

@@ -1,4 +1,4 @@
(api-only)=
(howto:api-only)=
# Deploying JupyterHub in "API only mode"

View File

@@ -1,3 +1,5 @@
(howto:config:gh-oauth)=
# Configure GitHub OAuth
In this example, we show a configuration file for a fairly standard JupyterHub

View File

@@ -1,3 +1,5 @@
(howto:config:reverse-proxy)=
# Using a reverse proxy
In the following example, we show configuration files for a JupyterHub server

View File

@@ -1,3 +1,5 @@
(howto:config:no-sudo)=
# Run JupyterHub without root privileges using `sudo`
**Note:** Setting up `sudo` permissions involves many pieces of system

View File

@@ -1,3 +1,5 @@
(howto:config:user-env)=
# Configuring user environments
To deploy JupyterHub means you are providing Jupyter notebook environments for

View File

@@ -1,3 +1,5 @@
(howto:log-messages)=
# Interpreting common log messages
When debugging errors and outages, looking at the logs emitted by

View File

@@ -1,3 +1,5 @@
(howto:custom-proxy)=
# Writing a custom Proxy implementation
JupyterHub 0.8 introduced the ability to write a custom implementation of the

View File

@@ -1,4 +1,4 @@
(using-jupyterhub-rest-api)=
(howto:rest-api)=
# Using JupyterHub's REST API

View File

@@ -1,4 +1,4 @@
(separate-proxy)=
(howto:separate-proxy)=
# Running proxy separately from the hub

View File

@@ -1,3 +1,5 @@
(howto:templates)=
# Working with templates and UI
The pages of the JupyterHub application are generated from

View File

@@ -1,4 +1,4 @@
(upgrading-v5)=
(howto:upgrading-v5)=
# Upgrading to JupyterHub 5

View File

@@ -1,4 +1,4 @@
(upgrading-jupyterhub)=
(howto:upgrading-jupyterhub)=
# Upgrading JupyterHub