From f9b2a05e1860412381948d45c8248b5b976cc062 Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Tue, 4 Apr 2023 21:44:58 +0200 Subject: [PATCH] docs: fix remaining issues following rst to myst transition --- docs/contributing/dev-setup.md | 22 ++++++++--------- docs/howto/admin/https.md | 6 ++--- docs/howto/auth/awscognito.md | 10 ++++---- docs/howto/auth/github.md | 6 ++--- docs/howto/providers/azure.md | 6 ++--- docs/topic/tljh-config.md | 45 +++++++++++++++++----------------- 6 files changed, 47 insertions(+), 48 deletions(-) diff --git a/docs/contributing/dev-setup.md b/docs/contributing/dev-setup.md index cc6e8b1..147c9dd 100644 --- a/docs/contributing/dev-setup.md +++ b/docs/contributing/dev-setup.md @@ -42,21 +42,21 @@ The easiest & safest way to develop & test TLJH is with [Docker](https://www.doc python3 /srv/src/bootstrap/bootstrap.py --admin admin ``` -> Or, if you would like to setup the admin's password during install, -> you can use this command (replace "admin" with the desired admin username -> and "password" with the desired admin password): -> -> > ```console -> > python3 /srv/src/bootstrap/bootstrap.py --admin admin:password -> > ``` -> > -> > The primary hub environment will also be in your PATH already for convenience. + Or, if you would like to setup the admin's password during install, + you can use this command (replace "admin" with the desired admin username + and "password" with the desired admin password): -1. You should be able to access the JupyterHub from your browser now at + ```console + python3 /srv/src/bootstrap/bootstrap.py --admin admin:password + ``` + + The primary hub environment will also be in your PATH already for convenience. + +7. You should be able to access the JupyterHub from your browser now at [http://localhost:12000](http://localhost:12000). Congratulations, you are set up to develop TLJH! -2. Make some changes to the repository. You can test easily depending on what +8. Make some changes to the repository. You can test easily depending on what you changed. - If you changed the `bootstrap/bootstrap.py` script or any of its dependencies, diff --git a/docs/howto/admin/https.md b/docs/howto/admin/https.md index 0c0696d..1cdb459 100644 --- a/docs/howto/admin/https.md +++ b/docs/howto/admin/https.md @@ -21,9 +21,9 @@ To do that, you would have to log in to the website of your registrar and go to the DNS records section. The interface will look like something similar to this: -> ```{image} ../../images/dns.png -> :alt: Adding an entry to the DNS records -> ``` +```{image} ../../images/dns.png +:alt: Adding an entry to the DNS records +``` ::: diff --git a/docs/howto/auth/awscognito.md b/docs/howto/auth/awscognito.md index e823647..ccb8893 100644 --- a/docs/howto/auth/awscognito.md +++ b/docs/howto/auth/awscognito.md @@ -29,11 +29,11 @@ application to your `tljh` configuration. http(s):// ``` - > - **Auth Domain** Create an auth domain e.g. \: - > - > ``` - > https://<.auth.eu-west-1.amazoncognito.com - > ``` + - **Auth Domain** Create an auth domain e.g. \: + + ``` + https://<.auth.eu-west-1.amazoncognito.com + ``` ## Install and configure an AWS EC2 Instance with userdata diff --git a/docs/howto/auth/github.md b/docs/howto/auth/github.md index 04635f8..a1ce701 100644 --- a/docs/howto/auth/github.md +++ b/docs/howto/auth/github.md @@ -29,9 +29,9 @@ You'll need a GitHub account in order to complete these steps. - When you're done filling in the page, it should look something like this: - > ```{image} ../../images/auth/github/create_application.png - > :alt: Create a GitHub OAuth application - > ``` + ```{image} ../../images/auth/github/create_application.png + :alt: Create a GitHub OAuth application + ``` 2. Click "Register application". You'll be taken to a page with the registered application details. diff --git a/docs/howto/providers/azure.md b/docs/howto/providers/azure.md index b61b75d..fd43015 100644 --- a/docs/howto/providers/azure.md +++ b/docs/howto/providers/azure.md @@ -23,9 +23,9 @@ To do either of this: - Click on "Stop" to stop the machine temporarily, or "Delete" to delete it permanently. - > ```{image} ../../images/providers/azure/delete-vm.png - > :alt: Delete vm - > ``` + ```{image} ../../images/providers/azure/delete-vm.png + :alt: Delete vm + ``` :::{note} It is important to mention that even if you stop the machine you will still be charged for the use of the data disk. diff --git a/docs/topic/tljh-config.md b/docs/topic/tljh-config.md index 8f672d6..ced4838 100644 --- a/docs/topic/tljh-config.md +++ b/docs/topic/tljh-config.md @@ -58,32 +58,32 @@ Some of the existing `` are listed below by categories: ### Base URL -> Use `base_url` to determine the base URL used by JupyterHub. This parameter will -> be passed straight to `c.JupyterHub.base_url`. +Use `base_url` to determine the base URL used by JupyterHub. This parameter will +be passed straight to `c.JupyterHub.base_url`. (tljh-set-auth)= ### Authentication -> Use `auth.type` to determine authenticator to use. All parameters -> in the config under `auth.{auth.type}` will be passed straight to the -> authenticators themselves. +Use `auth.type` to determine authenticator to use. All parameters +in the config under `auth.{auth.type}` will be passed straight to the +authenticators themselves. (tljh-set-ports)= ### Ports -> Use `http.port` and `https.port` to set the ports that TLJH will listen on, -> which are 80 and 443 by default. However, if you change these, note that -> TLJH does a lot of other things to the system (with user accounts and sudo -> rules primarily) that might break security assumptions your other -> applications have, so use with extreme caution. -> -> ```bash -> sudo tljh-config set http.port 8080 -> sudo tljh-config set https.port 8443 -> sudo tljh-config reload proxy -> ``` +Use `http.port` and `https.port` to set the ports that TLJH will listen on, +which are 80 and 443 by default. However, if you change these, note that +TLJH does a lot of other things to the system (with user accounts and sudo +rules primarily) that might break security assumptions your other +applications have, so use with extreme caution. + +```bash +sudo tljh-config set http.port 8080 +sudo tljh-config set https.port 8443 +sudo tljh-config reload proxy +``` (tljh-set-user-lists)= @@ -138,13 +138,12 @@ Some of the existing `` are listed below by categories: ### User Environment -> `user_environment.default_app` Set default application users are -> launched into. Currently can be set to the following values -> `jupyterlab` or `nteract` -> -> ```bash -> sudo tljh-config set user_environment.default_app jupyterlab -> ``` +`user_environment.default_app` Set default application users are +launched into. Currently this can only be set to: `jupyterlab` + +```bash +sudo tljh-config set user_environment.default_app jupyterlab +``` (tljh-set-extra-user-groups)=