mirror of
https://github.com/jupyterhub/jupyterhub.git
synced 2025-10-08 10:34: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:
@@ -1,4 +1,4 @@
|
||||
(api-only)=
|
||||
(howto:api-only)=
|
||||
|
||||
# Deploying JupyterHub in "API only mode"
|
||||
|
||||
|
@@ -1,3 +1,5 @@
|
||||
(howto:config:gh-oauth)=
|
||||
|
||||
# Configure GitHub OAuth
|
||||
|
||||
In this example, we show a configuration file for a fairly standard JupyterHub
|
||||
|
@@ -1,3 +1,5 @@
|
||||
(howto:config:reverse-proxy)=
|
||||
|
||||
# Using a reverse proxy
|
||||
|
||||
In the following example, we show configuration files for a JupyterHub server
|
||||
|
@@ -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
|
||||
|
@@ -1,3 +1,5 @@
|
||||
(howto:config:user-env)=
|
||||
|
||||
# Configuring user environments
|
||||
|
||||
To deploy JupyterHub means you are providing Jupyter notebook environments for
|
||||
|
@@ -1,3 +1,5 @@
|
||||
(howto:log-messages)=
|
||||
|
||||
# Interpreting common log messages
|
||||
|
||||
When debugging errors and outages, looking at the logs emitted by
|
||||
|
@@ -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
|
||||
|
@@ -1,4 +1,4 @@
|
||||
(using-jupyterhub-rest-api)=
|
||||
(howto:rest-api)=
|
||||
|
||||
# Using JupyterHub's REST API
|
||||
|
||||
|
@@ -1,4 +1,4 @@
|
||||
(separate-proxy)=
|
||||
(howto:separate-proxy)=
|
||||
|
||||
# Running proxy separately from the hub
|
||||
|
||||
|
@@ -1,3 +1,5 @@
|
||||
(howto:templates)=
|
||||
|
||||
# Working with templates and UI
|
||||
|
||||
The pages of the JupyterHub application are generated from
|
||||
|
@@ -1,4 +1,4 @@
|
||||
(upgrading-v5)=
|
||||
(howto:upgrading-v5)=
|
||||
|
||||
# Upgrading to JupyterHub 5
|
||||
|
||||
|
@@ -1,4 +1,4 @@
|
||||
(upgrading-jupyterhub)=
|
||||
(howto:upgrading-jupyterhub)=
|
||||
|
||||
# Upgrading JupyterHub
|
||||
|
||||
|
Reference in New Issue
Block a user