Merge pull request #870 from consideRatio/pr/misc-rst-followups

docs: fix remaining issues following rst to myst transition
This commit is contained in:
Erik Sundell
2023-04-04 21:58:09 +02:00
committed by GitHub
6 changed files with 47 additions and 48 deletions

View File

@@ -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 python3 /srv/src/bootstrap/bootstrap.py --admin admin
``` ```
> Or, if you would like to setup the admin's password during install, 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 you can use this command (replace "admin" with the desired admin username
> and "password" with the desired admin password): 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.
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 [http://localhost:12000](http://localhost:12000). Congratulations, you are
set up to develop TLJH! 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. you changed.
- If you changed the `bootstrap/bootstrap.py` script or any of its dependencies, - If you changed the `bootstrap/bootstrap.py` script or any of its dependencies,

View File

@@ -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 and go to the DNS records section. The interface will look like something
similar to this: similar to this:
> ```{image} ../../images/dns.png ```{image} ../../images/dns.png
> :alt: Adding an entry to the DNS records :alt: Adding an entry to the DNS records
> ``` ```
::: :::

View File

@@ -29,11 +29,11 @@ application to your `tljh` configuration.
http(s)://<my-tljh-ip-address> http(s)://<my-tljh-ip-address>
``` ```
> - **Auth Domain** Create an auth domain e.g. \<my_jupyter_hub>: - **Auth Domain** Create an auth domain e.g. \<my_jupyter_hub>:
>
> ``` ```
> https://<<my_jupyter_hub>.auth.eu-west-1.amazoncognito.com https://<<my_jupyter_hub>.auth.eu-west-1.amazoncognito.com
> ``` ```
## Install and configure an AWS EC2 Instance with userdata ## Install and configure an AWS EC2 Instance with userdata

View File

@@ -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: - When you're done filling in the page, it should look something like this:
> ```{image} ../../images/auth/github/create_application.png ```{image} ../../images/auth/github/create_application.png
> :alt: Create a GitHub OAuth application :alt: Create a GitHub OAuth application
> ``` ```
2. Click "Register application". You'll be taken to a page with the registered application details. 2. Click "Register application". You'll be taken to a page with the registered application details.

View File

@@ -23,9 +23,9 @@ To do either of this:
- Click on "Stop" to stop the machine temporarily, or "Delete" to delete it permanently. - Click on "Stop" to stop the machine temporarily, or "Delete" to delete it permanently.
> ```{image} ../../images/providers/azure/delete-vm.png ```{image} ../../images/providers/azure/delete-vm.png
> :alt: Delete vm :alt: Delete vm
> ``` ```
:::{note} :::{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. It is important to mention that even if you stop the machine you will still be charged for the use of the data disk.

View File

@@ -58,32 +58,32 @@ Some of the existing `<property-path>` are listed below by categories:
### Base URL ### Base URL
> Use `base_url` to determine the base URL used by JupyterHub. This parameter will Use `base_url` to determine the base URL used by JupyterHub. This parameter will
> be passed straight to `c.JupyterHub.base_url`. be passed straight to `c.JupyterHub.base_url`.
(tljh-set-auth)= (tljh-set-auth)=
### Authentication ### Authentication
> Use `auth.type` to determine authenticator to use. All parameters Use `auth.type` to determine authenticator to use. All parameters
> in the config under `auth.{auth.type}` will be passed straight to the in the config under `auth.{auth.type}` will be passed straight to the
> authenticators themselves. authenticators themselves.
(tljh-set-ports)= (tljh-set-ports)=
### Ports ### Ports
> Use `http.port` and `https.port` to set the ports that TLJH will listen on, 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 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 TLJH does a lot of other things to the system (with user accounts and sudo
> rules primarily) that might break security assumptions your other rules primarily) that might break security assumptions your other
> applications have, so use with extreme caution. applications have, so use with extreme caution.
>
> ```bash ```bash
> sudo tljh-config set http.port 8080 sudo tljh-config set http.port 8080
> sudo tljh-config set https.port 8443 sudo tljh-config set https.port 8443
> sudo tljh-config reload proxy sudo tljh-config reload proxy
> ``` ```
(tljh-set-user-lists)= (tljh-set-user-lists)=
@@ -138,13 +138,12 @@ Some of the existing `<property-path>` are listed below by categories:
### User Environment ### User Environment
> `user_environment.default_app` Set default application users are `user_environment.default_app` Set default application users are
> launched into. Currently can be set to the following values launched into. Currently this can only be set to: `jupyterlab`
> `jupyterlab` or `nteract`
> ```bash
> ```bash sudo tljh-config set user_environment.default_app jupyterlab
> sudo tljh-config set user_environment.default_app jupyterlab ```
> ```
(tljh-set-extra-user-groups)= (tljh-set-extra-user-groups)=