From 76dadd7ef91fba1dc31fe6f7512f4d782196308e Mon Sep 17 00:00:00 2001 From: Min RK Date: Mon, 27 Mar 2023 09:56:46 +0200 Subject: [PATCH] fix absolute refs myst seems to create different refs than sphinx --- docs/contributing/code-review.md | 4 ++-- docs/contributing/dev-setup.md | 2 +- docs/contributing/docs.md | 2 +- docs/contributing/plugins.md | 2 +- docs/howto/admin/admin-users.md | 2 +- docs/howto/admin/https.md | 8 ++++---- docs/howto/admin/resize.md | 4 ++-- docs/howto/admin/resource-estimation.md | 2 +- docs/howto/auth/awscognito.md | 4 ++-- docs/howto/auth/github.md | 4 ++-- docs/howto/auth/google.md | 4 ++-- docs/howto/content/add-data.md | 8 ++++---- docs/howto/content/share-data.md | 4 ++-- docs/howto/index.md | 2 +- docs/howto/providers/digitalocean.md | 2 +- docs/index.md | 2 +- docs/install/add_packages.txt | 2 +- docs/install/amazon.md | 8 ++++---- docs/install/azure.md | 4 ++-- docs/install/custom-server.md | 10 +++++----- docs/install/digitalocean.md | 6 +++--- docs/install/google.md | 8 ++++---- docs/install/jetstream.md | 6 +++--- docs/install/ovh.md | 4 ++-- docs/topic/authenticator-configuration.md | 4 ++-- docs/topic/customizing-installer.md | 2 +- docs/topic/requirements.md | 2 +- docs/topic/security.md | 2 +- docs/troubleshooting/logs.md | 6 +++--- 29 files changed, 60 insertions(+), 60 deletions(-) diff --git a/docs/contributing/code-review.md b/docs/contributing/code-review.md index ce96e3d..209cba6 100644 --- a/docs/contributing/code-review.md +++ b/docs/contributing/code-review.md @@ -24,7 +24,7 @@ not to have _perfect_ documentation before merging a pull request. If you are new and not sure how to add documentation, other contributors will be happy to guide you. -See {ref}`contributing/docs` for guidelines on writing documentation. +See [](/contributing/docs) for guidelines on writing documentation. ## Write tests @@ -43,4 +43,4 @@ add more tests. If you are unsure what kind of tests to add for your pull request, other contributors to the repo will be happy to help guide you! -See {ref}`contributing/tests` for guidelines on writing tests. +See [](/contributing/tests) for guidelines on writing tests. diff --git a/docs/contributing/dev-setup.md b/docs/contributing/dev-setup.md index 35f8016..cc6e8b1 100644 --- a/docs/contributing/dev-setup.md +++ b/docs/contributing/dev-setup.md @@ -68,5 +68,5 @@ The easiest & safest way to develop & test TLJH is with [Docker](https://www.doc restart jupyterhub for them to take effect. `tljh-config reload hub` should do that. -{ref}`troubleshooting/logs` has information on looking at various logs in the container +[](/troubleshooting/logs) has information on looking at various logs in the container to debug issues you might have. diff --git a/docs/contributing/docs.md b/docs/contributing/docs.md index be45e0a..bc4d6c0 100644 --- a/docs/contributing/docs.md +++ b/docs/contributing/docs.md @@ -59,7 +59,7 @@ If you encounter this error, it's likely that you are running inside a virtual e Error in "currentmodule" directive: ``` -To get started contributing, you'll want to read the {ref}`reStructuredText reference ` +To get started contributing, you'll want to read the `reStructuredText reference ` Your locally-built documentation will be themed differently than the documentation at [the-littlest-jupyterhub.readthedocs.io](https://the-littlest-jupyterhub.readthedocs.io). diff --git a/docs/contributing/plugins.md b/docs/contributing/plugins.md index a076485..6151b8d 100644 --- a/docs/contributing/plugins.md +++ b/docs/contributing/plugins.md @@ -20,7 +20,7 @@ stability required for a good plugin ecosystem. ## Installing Plugins -Include `--plugin ` in the Installer script. See {ref}`topic/customizing-installer` for more info. +Include `--plugin ` in the Installer script. See [](/topic/customizing-installer) for more info. ## Writing a simple plugins diff --git a/docs/howto/admin/admin-users.md b/docs/howto/admin/admin-users.md index 99b935e..1102853 100644 --- a/docs/howto/admin/admin-users.md +++ b/docs/howto/admin/admin-users.md @@ -17,7 +17,7 @@ so attackers can not easily gain control of the system. :::{important} You should make sure an admin user is present when you **install** TLJH the very first time. It is recommended that you also set a password -for the admin at this step. The {ref}`--admin ` +for the admin at this step. The [`--admin`] (/topic/customizing-installer/admin) flag passed to the installer does this. If you had forgotten to do so, the easiest way to fix this is to run the installer again. ::: diff --git a/docs/howto/admin/https.md b/docs/howto/admin/https.md index 2a4a508..0c0696d 100644 --- a/docs/howto/admin/https.md +++ b/docs/howto/admin/https.md @@ -8,9 +8,9 @@ HTTPS encrypts traffic so that usernames, passwords and your data are communicated securely. sensitive bits of information are communicated securely. The Littlest JupyterHub supports automatically configuring HTTPS via [Let's Encrypt](https://letsencrypt.org), or setting it up -{ref}`manually ` with your own TLS key and +[manually](#howto-admin-https-manual) with your own TLS key and certificate. Unless you have a strong reason to use the manual method, -you should use the {ref}`Let's Encrypt ` +you should use the [Let's Encrypt](#howto-admin-https-letsencrypt) method. :::{note} @@ -35,7 +35,7 @@ similar to this: If the machine you are running on is not reachable from the internet - for example, if it is a machine internal to your organization that is cut off from the internet - you can not use this method. Please -set up a DNS entry and HTTPS {ref}`manually `. +set up a DNS entry and HTTPS [manually](#howto-admin-https-manual). ::: To enable HTTPS via letsencrypt: @@ -115,4 +115,4 @@ and now access your Hub securely at . ## Troubleshooting -If you're having trouble with HTTPS, looking at the {ref}`traefik proxy logs ` might help. +If you're having trouble with HTTPS, looking at the [traefik proxy logs](troubleshooting-logs-traefik) might help. diff --git a/docs/howto/admin/resize.md b/docs/howto/admin/resize.md index 0cd3f71..44d7ba2 100644 --- a/docs/howto/admin/resize.md +++ b/docs/howto/admin/resize.md @@ -11,7 +11,7 @@ the cloud provider of your choice. Currently there are instructions to resize your resources on the following providers: -- {ref}`Digital Ocean `. +- [Digital Ocean](howto-providers-digitalocean-resize) Once resources have been reallocated, you must tell TLJH to make use of these resources, and verify that the resources have become available. @@ -20,7 +20,7 @@ and verify that the resources have become available. 1. Once you have resized your server, tell the JupyterHub to make use of these new resources. To accomplish this, follow the instructions in - {ref}`topic/tljh-config` to set new memory or CPU limits and reload the hub. This can be completed + [](/topic/tljh-config) to set new memory or CPU limits and reload the hub. This can be completed using the terminal in the JupyterHub (or via SSH-ing into your VM and using this terminal). 2. TLJH configuration options can be verified by viewing the tljh-config output. diff --git a/docs/howto/admin/resource-estimation.md b/docs/howto/admin/resource-estimation.md index 8c1585e..9bc7113 100644 --- a/docs/howto/admin/resource-estimation.md +++ b/docs/howto/admin/resource-estimation.md @@ -36,7 +36,7 @@ over time. We generally recommend between 40-60% of your total class size to sta Depending on what kind of work your users are doing, they will use different amounts of memory. The easiest way to determine this is to run through a typical user -workflow yourself, and measure how much memory is used. You can use {ref}`howto/admin/nbresuse` +workflow yourself, and measure how much memory is used. You can use [](/howto/admin/nbresuse) to determine how much memory your user is using. A good rule of thumb is to take the maximum amount of memory you used during diff --git a/docs/howto/auth/awscognito.md b/docs/howto/auth/awscognito.md index cb96100..1fed27e 100644 --- a/docs/howto/auth/awscognito.md +++ b/docs/howto/auth/awscognito.md @@ -102,7 +102,7 @@ c.GenericOAuthenticator.userdata_method = "POST" ``` We'll use the `tljh-config` tool to configure your JupyterHub's authentication. -For more information on `tljh-config`, see {ref}`topic/tljh-config`. +For more information on `tljh-config`, see [](/topic/tljh-config). 1. Tell your JupyterHub to use the GenericOAuthenticator for authentication: @@ -125,4 +125,4 @@ For more information on `tljh-config`, see {ref}`topic/tljh-config`. 4. You will likely have to create a new user (sign up) and then you should be directed to the Jupyter interface used in this JupyterHub. 5. **If this does not work** you can revert back to the default - JupyterHub authenticator by following the steps in {ref}`howto/auth/firstuse`. + JupyterHub authenticator by following the steps in [](/howto/auth/firstuse). diff --git a/docs/howto/auth/github.md b/docs/howto/auth/github.md index c9b6709..04635f8 100644 --- a/docs/howto/auth/github.md +++ b/docs/howto/auth/github.md @@ -52,7 +52,7 @@ with the new IP address. ## Configure your JupyterHub to use the GitHub Oauthenticator We'll use the `tljh-config` tool to configure your JupyterHub's authentication. -For more information on `tljh-config`, see {ref}`topic/tljh-config`. +For more information on `tljh-config`, see [](/topic/tljh-config). 1. Log in as an administrator account to your JupyterHub. @@ -105,4 +105,4 @@ For more information on `tljh-config`, see {ref}`topic/tljh-config`. Jupyter interface used in this JupyterHub. 5. **If this does not work** you can revert back to the default - JupyterHub authenticator by following the steps in {ref}`howto/auth/firstuse`. + JupyterHub authenticator by following the steps in [](/howto/auth/firstuse). diff --git a/docs/howto/auth/google.md b/docs/howto/auth/google.md index 8ecb3b6..1557a4c 100644 --- a/docs/howto/auth/google.md +++ b/docs/howto/auth/google.md @@ -77,7 +77,7 @@ with the new IP address. ## Configure your JupyterHub to use the Google Oauthenticator We'll use the `tljh-config` tool to configure your JupyterHub's authentication. -For more information on `tljh-config`, see {ref}`topic/tljh-config`. +For more information on `tljh-config`, see [](/topic/tljh-config). 1. Log in as an administrator account to your JupyterHub. @@ -130,4 +130,4 @@ For more information on `tljh-config`, see {ref}`topic/tljh-config`. Jupyter interface used in this JupyterHub. 5. **If this does not work** you can revert back to the default - JupyterHub authenticator by following the steps in {ref}`howto/auth/firstuse`. + JupyterHub authenticator by following the steps in [](/howto/auth/firstuse). diff --git a/docs/howto/content/add-data.md b/docs/howto/content/add-data.md index 0ff6d59..9115877 100644 --- a/docs/howto/content/add-data.md +++ b/docs/howto/content/add-data.md @@ -4,13 +4,13 @@ This section covers how to add data to your JupyterHub either from the internet or from your own machine. To learn how to **share data** that is already -on your JupyterHub, see {ref}`howto/content/share-data`. +on your JupyterHub, see [](/howto/content/share-data). :::{note} When you add data using the methods on this page, you will **only add it to your user directory**. This is not a place that is accessible to others. For information on sharing this data with users on the JupyterHub, see -{ref}`howto/content/share-data`. +[](/howto/content/share-data). ::: ## Adding data from your local machine @@ -40,7 +40,7 @@ interface. To do so, follow these steps: be on your JupyterHub, your home user's home directory. To learn how to **share** this data with new users on the JupyterHub, -see {ref}`howto/content/share-data`. +see [](/howto/content/share-data). ## Downloading data from the command line @@ -95,6 +95,6 @@ time. You can download it from your browser [at this link](https://swcarpentry.g 5. Confirm that your data was unzipped. It could be in a folder called `data/`. To learn how to **share** this data with new users on the JupyterHub, -see {ref}`howto/content/share-data`. +see [](/howto/content/share-data). % TODO: Downloading data with the "download" module in Python? https://github.com/choldgraf/download diff --git a/docs/howto/content/share-data.md b/docs/howto/content/share-data.md index 672cc75..27ffd1b 100644 --- a/docs/howto/content/share-data.md +++ b/docs/howto/content/share-data.md @@ -13,7 +13,7 @@ contained in the link's target repository is downloaded to the user's home directory. Note that a copy of the dataset will be made for each user. For information on creating and sharing `nbgitpuller` links, see -{ref}`howto/content/nbgitpuller`. +[](/howto/content/nbgitpuller). ## Option 2: Create a read-only shared folder for data @@ -37,7 +37,7 @@ steps: sudo mkdir -p /srv/data/my_shared_data_folder ``` -4. **Download the data** into this folder. See {ref}`howto/content/add-data` for +4. **Download the data** into this folder. See [](/howto/content/add-data) for details on how to do this. 5. All users now have read access to the data in this folder. diff --git a/docs/howto/index.md b/docs/howto/index.md index 2bc0273..7a73b8c 100644 --- a/docs/howto/index.md +++ b/docs/howto/index.md @@ -28,7 +28,7 @@ env/server-resources We have a special set of How-To Guides on using various forms of authentication with your JupyterHub. For more information on Authentication, see -{ref}`topic/authenticator-configuration` +[](/topic/authenticator-configuration) ```{toctree} :titlesonly: true diff --git a/docs/howto/providers/digitalocean.md b/docs/howto/providers/digitalocean.md index 4528f6e..1630096 100644 --- a/docs/howto/providers/digitalocean.md +++ b/docs/howto/providers/digitalocean.md @@ -39,4 +39,4 @@ disk space, or CPUs. Digital Ocean servers can be resized in the Now that you've resized your Droplet, you may want to change the resources available to your users. Further information on making more resources available to -users and verifying resource availability can be found in {ref}`howto/admin/resize`. +users and verifying resource availability can be found in [](/howto/admin/resize). diff --git a/docs/index.md b/docs/index.md index b542c4b..dddc39e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,7 +2,7 @@ A simple [JupyterHub](https://github.com/jupyterhub/jupyterhub) distribution for a small (0-100) number of users on a single server. We recommend reading -{ref}`topic/whentouse` to determine if this is the right tool for you. +[](/topic/whentouse) to determine if this is the right tool for you. ## Development Status diff --git a/docs/install/add_packages.txt b/docs/install/add_packages.txt index f21072f..56ad124 100644 --- a/docs/install/add_packages.txt +++ b/docs/install/add_packages.txt @@ -27,4 +27,4 @@ The packages ``gdal`` and ``there`` are now available to all users in JupyterHub If a user already had a python notebook running, they have to restart their notebook's kernel to make the new libraries available. -See :ref:`howto/env/user_environment` for more information. +See :ref:`howto-env-user-environment` for more information. diff --git a/docs/install/amazon.md b/docs/install/amazon.md index 0ee8915..1c45ef1 100644 --- a/docs/install/amazon.md +++ b/docs/install/amazon.md @@ -72,7 +72,7 @@ Let's create the server on which we can run JupyterHub. offers. Select the one you want and then select the button `Next: Configure Instance Details` in the lower right corner. - Check out our guide on How To {ref}`howto/admin/resource-estimation` to help pick + Check out our guide on How To [](/howto/admin/resource-estimation) to help pick how much Memory / CPU your server needs. We recommend you use a server with at least 2GB of RAM, such as a **t3.small**. However, if you need to minimise costs you can use a server with **1GB** RAM such as a **t2.micro**, but performance will be limited. @@ -101,8 +101,8 @@ Let's create the server on which we can run JupyterHub. ``` :::{note} - See {ref}`topic/installer-actions` for a detailed description and - {ref}`topic/customizing-installer` for other options that can be used. + See [](/topic/installer-actions) for a detailed description and + [](/topic/customizing-installer) for other options that can be used. ::: 8. Under **Step 4: Add Storage**, you can change the **size** and **type of your @@ -112,7 +112,7 @@ Let's create the server on which we can run JupyterHub. :alt: Selecting disk size and type ``` - Check out {ref}`howto/admin/resource-estimation` to help pick + Check out [](/howto/admin/resource-estimation) to help pick how much Disk space your server needs. Hover over the encircled `i` next to **Volume Type** for an explanation of diff --git a/docs/install/azure.md b/docs/install/azure.md index 9b66ebb..e46d83d 100644 --- a/docs/install/azure.md +++ b/docs/install/azure.md @@ -161,8 +161,8 @@ A new screen with all the options for Virtual Machines in Azure will displayed. ``` :::{note} - See {ref}`topic/installer-actions` if you want to understand exactly what the installer is doing. - {ref}`topic/customizing-installer` documents other options that can be passed to the installer. + See [](/topic/installer-actions) if you want to understand exactly what the installer is doing. + [](/topic/customizing-installer) documents other options that can be passed to the installer. ::: 8. Check the summary and confirm the creation of your Virtual Machine. diff --git a/docs/install/custom-server.md b/docs/install/custom-server.md index df64e65..abb21cd 100644 --- a/docs/install/custom-server.md +++ b/docs/install/custom-server.md @@ -14,7 +14,7 @@ on your personal computer. :::{note} Running TLJH _inside_ a docker container is not supported, since we depend on systemd. If you want to run TLJH locally for development, see -{ref}`contributing/dev-setup`. +[](/contributing/dev-setup). ::: ## Goal @@ -31,7 +31,7 @@ a server you have access to. 4. Ability to `ssh` into the server & run commands from the prompt. 5. An **IP address** where the server can be reached from the browsers of your target audience. -If you run into issues, look at the specific {ref}`troubleshooting guide ` +If you run into issues, look at the specific [troubleshooting guide](/troubleshooting/providers/custom) for custom server installations. ## Step 1: Installing The Littlest JupyterHub @@ -56,8 +56,8 @@ for custom server installations. ``` :::{note} - See {ref}`topic/installer-actions` if you want to understand exactly what the installer is doing. - {ref}`topic/customizing-installer` documents other options that can be passed to the installer. + See [](/topic/installer-actions) if you want to understand exactly what the installer is doing. + [](/topic/customizing-installer) documents other options that can be passed to the installer. ::: 4. Press `Enter` to start the installation process. This will take 5-10 minutes, @@ -92,4 +92,4 @@ for custom server installations. ## Step 4: Setup HTTPS Once you are ready to run your server for real, and have a domain, it's a good -idea to proceed directly to {ref}`howto/admin/https`. +idea to proceed directly to [](/howto/admin/https). diff --git a/docs/install/digitalocean.md b/docs/install/digitalocean.md index 03b49e2..78f9ec4 100644 --- a/docs/install/digitalocean.md +++ b/docs/install/digitalocean.md @@ -40,7 +40,7 @@ Let's create the server on which we can run JupyterHub. (4GB RAM, 2CPUs, 20 USD / month) is not a bad start. You can resize your server later if you need. - Check out our guide on How To {ref}`howto/admin/resource-estimation` to help pick + Check out our guide on How To [](/howto/admin/resource-estimation) to help pick how much Memory, CPU & disk space your server needs. 5. Scroll down to **Select additional options**, and select **User data**. @@ -66,8 +66,8 @@ Let's create the server on which we can run JupyterHub. ``` :::{note} - See {ref}`topic/installer-actions` if you want to understand exactly what the installer is doing. - {ref}`topic/customizing-installer` documents other options that can be passed to the installer. + See [](/topic/installer-actions) if you want to understand exactly what the installer is doing. + [](/topic/customizing-installer) documents other options that can be passed to the installer. ::: 7. Under the **Finalize and create** section, enter a `hostname` that descriptively diff --git a/docs/install/google.md b/docs/install/google.md index 60c68a7..b84bda1 100644 --- a/docs/install/google.md +++ b/docs/install/google.md @@ -84,7 +84,7 @@ Let's create the server on which we can run JupyterHub. :alt: Select a customized VM size ``` - Check out our guide on How To {ref}`howto/admin/resource-estimation` to help pick + Check out our guide on How To [](/howto/admin/resource-estimation) to help pick how much Memory / CPU your server needs. 11. Under **Boot Disk**, click the **Change** button. This lets us change the @@ -113,7 +113,7 @@ Let's create the server on which we can run JupyterHub. to a hard drive. **SSD persistent disk** gives you a faster but more expensive disk, similar to an SSD. - Check out our guide on How To {ref}`howto/admin/resource-estimation` to help pick + Check out our guide on How To [](/howto/admin/resource-estimation) to help pick how much Disk space your server needs. 14. Click the **Select** button to dismiss the Boot disk popup and go back to the @@ -160,8 +160,8 @@ Let's create the server on which we can run JupyterHub. ``` :::{note} - See {ref}`topic/installer-actions` if you want to understand exactly what the installer is doing. - {ref}`topic/customizing-installer` documents other options that can be passed to the installer. + See [](/topic/installer-actions) if you want to understand exactly what the installer is doing. + [](/topic/customizing-installer) documents other options that can be passed to the installer. ::: 19. Click the **Create** button at the bottom to start your server! diff --git a/docs/install/jetstream.md b/docs/install/jetstream.md index d0ad7e3..680a43c 100644 --- a/docs/install/jetstream.md +++ b/docs/install/jetstream.md @@ -55,7 +55,7 @@ Let's create the server on which we can run JupyterHub. 2. Select an appropriate **Instance Size**. We suggest m1.medium or larger. Make sure your instance has at least **1GB** of RAM. - Check out our guide on How To {ref}`howto/admin/resource-estimation` to help pick + Check out our guide on How To [](/howto/admin/resource-estimation) to help pick how much Memory, CPU & disk space your server needs. 3. If you have multiple allocations, make sure you are 'charging' this server @@ -93,8 +93,8 @@ Let's create the server on which we can run JupyterHub. ``` :::{note} - See {ref}`topic/installer-actions` if you want to understand exactly what the installer is doing. - {ref}`topic/customizing-installer` documents other options that can be passed to the installer. + See [](/topic/installer-actions) if you want to understand exactly what the installer is doing. + [](/topic/customizing-installer) documents other options that can be passed to the installer. ::: 9. Under **Execution Strategy Type**, select **Run script on first boot**. diff --git a/docs/install/ovh.md b/docs/install/ovh.md index 74d8dc6..a979dba 100644 --- a/docs/install/ovh.md +++ b/docs/install/ovh.md @@ -77,8 +77,8 @@ Let's create the server on which we can run JupyterHub. ``` :::{note} - See {ref}`topic/installer-actions` if you want to understand exactly what the installer is doing. - {ref}`topic/customizing-installer` documents other options that can be passed to the installer. + See [](/topic/installer-actions) if you want to understand exactly what the installer is doing. + [](/topic/customizing-installer) documents other options that can be passed to the installer. ::: ```{image} ../images/providers/ovh/configuration.png diff --git a/docs/topic/authenticator-configuration.md b/docs/topic/authenticator-configuration.md index 3a64a11..2b9f2b9 100644 --- a/docs/topic/authenticator-configuration.md +++ b/docs/topic/authenticator-configuration.md @@ -10,7 +10,7 @@ can be used with TLJH. A number of them ship by default with TLJH: OAuth based authentication methods. 2. [LDAPAuthenticator](https://github.com/jupyterhub/ldapauthenticator) - LDAP & Active Directory. 3. [DummyAuthenticator](https://github.com/yuvipanda/jupyterhub-dummy-authenticator) - Any username, - one shared password. A {ref}`how-to guide on using DummyAuthenticator ` is also + one shared password. A [how-to guide on using DummyAuthenticator](howto-auth-dummy) is also available. 4. [FirstUseAuthenticator](https://github.com/yuvipanda/jupyterhub-firstuseauthenticator) - Users set their password when they log in for the first time. Default authenticator used in TLJH. @@ -75,7 +75,7 @@ sudo tljh-config reload Try logging in a separate incognito window to check if your configuration works. This lets you preserve your terminal in case there were errors. If there are -errors, {ref}`troubleshooting/logs` should help you debug them. +errors, [](/troubleshooting/logs) should help you debug them. ### Example diff --git a/docs/topic/customizing-installer.md b/docs/topic/customizing-installer.md index cfb4ec1..151fe7f 100644 --- a/docs/topic/customizing-installer.md +++ b/docs/topic/customizing-installer.md @@ -110,7 +110,7 @@ The Littlest JupyterHub can install additional _plugins_ that provide additional features. They are most commonly used to install a particular _stack_ - such as the [PANGEO Stack](https://github.com/yuvipanda/tljh-pangeo) for earth sciences research, a stack for a particular class, etc. You can find more information about -writing plugins and a list of existing plugins at {ref}`contributing/plugins`. +writing plugins and a list of existing plugins at [](/contributing/plugins). `--plugin ` installs and activates a plugin. You can pass it however many times you want. Since plugins are distributed as python packages, diff --git a/docs/topic/requirements.md b/docs/topic/requirements.md index 74cdeec..3d2df1e 100644 --- a/docs/topic/requirements.md +++ b/docs/topic/requirements.md @@ -20,4 +20,4 @@ about how to get HTTP traffic from the world into your server. ## CPU / Memory / Disk Space -See how to {ref}`howto/admin/resource-estimation` +See how to [](/howto/admin/resource-estimation) diff --git a/docs/topic/security.md b/docs/topic/security.md index 6e12cc2..23d94bc 100644 --- a/docs/topic/security.md +++ b/docs/topic/security.md @@ -66,4 +66,4 @@ feature of systemd. ## HTTPS Any internet-facing JupyterHub should use HTTPS to secure its traffic. For -information on how to use HTTPS with your JupyterHub, see {ref}`howto/admin/https`. +information on how to use HTTPS with your JupyterHub, see [](/howto/admin/https). diff --git a/docs/troubleshooting/logs.md b/docs/troubleshooting/logs.md index 06eb3ea..b488494 100644 --- a/docs/troubleshooting/logs.md +++ b/docs/troubleshooting/logs.md @@ -37,7 +37,7 @@ logs is a great first step. sudo journalctl -u jupyterhub ``` -This command displays logs from JupyterHub itself. See {ref}`journalctl_tips` +This command displays logs from JupyterHub itself. See [](#journalctl-tips) for tips on navigating the logs. (troubleshooting-logs-traefik)= @@ -52,7 +52,7 @@ is one line cryptic error messages, or if you are having trouble with HTTPS. sudo journalctl -u traefik ``` -This command displays logs from Traefik. See {ref}`journalctl_tips` +This command displays logs from Traefik. See [](#journalctl-tips) for tips on navigating the logs. ## User Server Logs @@ -67,7 +67,7 @@ sudo journalctl -u jupyter- This command displays logs from the given user's notebook server. You can get a list of all users from the "users" button at the top-right of the Admin page. -See {ref}`journalctl_tips` for tips on navigating the logs. +See [](#journalctl-tips) for tips on navigating the logs. (journalctl-tips)=