hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-12 04:23:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Provide consistent myst references to documentation pages

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/source/explanation/concepts.md
View File

@@ -1,3 +1,5 @@
(explanation:concepts)=
# JupyterHub: A conceptual overview
```{warning}
@@ -201,7 +203,7 @@ running, the notebooks). By default, the hub starts the proxy
automatically
and stops the proxy when the hub stops (so that connections get
interrupted). But when you [configure the proxy to run
separately](separate-proxy),
separately](howto:separate-proxy),
user's connections will continue to work even without the hub.
The default proxy is **ConfigurableHttpProxy** which is simple but