From 512935abb777535c3ade219835a59872ab233721 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 27 Aug 2025 00:14:44 +0000 Subject: [PATCH] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- README.md | 1 - docs/contributing/dev-setup.md | 1 - docs/howto/auth/awscognito.md | 1 - docs/howto/auth/github.md | 1 - docs/howto/auth/google.md | 1 - docs/howto/user-env/user-environment.md | 1 - docs/install/azure.md | 9 --------- docs/install/jetstream.md | 8 ++++---- docs/topic/whentouse.md | 2 -- docs/troubleshooting/logs.md | 1 - 10 files changed, 4 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index a8e2d0b..beca908 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,6 @@ We have several tutorials to get you started. - Tutorials to create a new server from scratch on a cloud provider & run TLJH on it. These are **recommended** if you do not have much experience setting up servers. - - [Digital Ocean](https://the-littlest-jupyterhub.readthedocs.io/en/latest/install/digitalocean.html) - [OVH](https://the-littlest-jupyterhub.readthedocs.io/en/latest/install/ovh.html) - [Google Cloud](https://the-littlest-jupyterhub.readthedocs.io/en/latest/install/google.html) diff --git a/docs/contributing/dev-setup.md b/docs/contributing/dev-setup.md index 3336723..ff1b6f1 100644 --- a/docs/contributing/dev-setup.md +++ b/docs/contributing/dev-setup.md @@ -61,7 +61,6 @@ The easiest & safest way to develop & test TLJH is with [Docker](https://www.doc 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, you can test it by running `python3 /srv/src/bootstrap/bootstrap.py`. - If you changed the `tljh/installer.py` code (or any of its dependencies), diff --git a/docs/howto/auth/awscognito.md b/docs/howto/auth/awscognito.md index 2e89fa4..4d39f53 100644 --- a/docs/howto/auth/awscognito.md +++ b/docs/howto/auth/awscognito.md @@ -24,7 +24,6 @@ application to your `tljh` configuration. 1. Create a user pool [Getting Started with User Pool](https://docs.aws.amazon.com/cognito/latest/developerguide/getting-started-with-cognito-user-pools.html). When you have completed creating a user pool, app, and domain you should have the following settings available to you: - - **App client id**: From the App client page - **App client secret** From the App client page diff --git a/docs/howto/auth/github.md b/docs/howto/auth/github.md index 2e5baf5..7048738 100644 --- a/docs/howto/auth/github.md +++ b/docs/howto/auth/github.md @@ -26,7 +26,6 @@ You'll need a GitHub account in order to complete these steps. ## Step 1: Create a GitHub application 1. Go to the [GitHub OAuth app creation page](https://github.com/settings/applications/new). - - **Application name**: Choose a descriptive application name (e.g. `tljh`) - **Homepage URL**: Use the IP address or URL of your JupyterHub. e.g. `` http(s)://` ``. diff --git a/docs/howto/auth/google.md b/docs/howto/auth/google.md index 2d74893..e763749 100644 --- a/docs/howto/auth/google.md +++ b/docs/howto/auth/google.md @@ -51,7 +51,6 @@ and create a new project: ``` - You will have to fill a form with: - - **Application type**: Choose _Web application_ - **Name**: A descriptive name for your OAuth client ID (e.g. `tljh-client`) diff --git a/docs/howto/user-env/user-environment.md b/docs/howto/user-env/user-environment.md index 74b7285..41c2545 100644 --- a/docs/howto/user-env/user-environment.md +++ b/docs/howto/user-env/user-environment.md @@ -180,7 +180,6 @@ To upgrade the Python version of the user environment, one can: environment, but you may do so manually. **Steps:** - 1. Activate the user environment, if using ssh. If the terminal was started with JupyterHub, this step can be skipped: diff --git a/docs/install/azure.md b/docs/install/azure.md index a9f862f..752cf8f 100644 --- a/docs/install/azure.md +++ b/docs/install/azure.md @@ -51,7 +51,6 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest ``` 5. **Choose an Ubuntu server for your VM**: - - Click `Ubuntu Server 22.04 LTS.` - Make sure `Resource Manager` is selected in the next screen and click **Create** @@ -61,7 +60,6 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest ``` 6. Customise the Virtual Machine basics: - - **Subscription**. Choose the "Free Trial" if this is what you're using. Otherwise, choose a different plan. This is the billing account that will be charged. - **Resource group**. Resource groups let you keep your Azure tools/resources together in an availability region (e.g. WestEurope). If you already have one you'd like to use it select that resource. @@ -89,7 +87,6 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest - **Inbound port rules**. Leave the defaults for now, and we will update these later on in the Network configuration step. 7. Before clicking on "Next" we need to select the RAM size for the image. - - For this we need to make sure we have enough RAM to accommodate your users. For example, if each user needs 2GB of RAM, and you have 10 total users, you need at least 20GB of RAM on the machine. It's also good to have a few GB of "buffer" RAM beyond what you think you'll need. - Click on **Change size** (see image below) @@ -105,7 +102,6 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest - Select a suitable image (to check available images and prices in your region [click on this link](https://azuremarketplace.microsoft.com/en-gb/marketplace/apps/Canonical.UbuntuServer?tab=PlansAndPrice/?wt.mc_id=TLJH-github-taallard)). 8. Disks (Storage): - - **Disk options**: select the OS disk type there are options for SDD and HDD. **SSD persistent disk** gives you a faster but more expensive disk than HDD. - **Data disk**. Click on create and attach a new disk. Select an appropriate type and size and click ok. @@ -120,7 +116,6 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest ``` 9. Networking - - **Virtual network**. Leave the default values selected. - **Subnet**. Leave the default values selected. - **Public IP address**.Leave the default values selected. This will make your server accessible from a browser. @@ -132,9 +127,7 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest ``` 10. Management - - Monitoring - - **Boot diagnostics**. Choose "On". - **OS guest diagnostics**. Choose "Off". - **Diagnostics storage account**. Leave as the default. @@ -150,7 +143,6 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest ``` 11. Advanced settings - - **Extensions**. Make sure there are no extensions listed - **Cloud init**. We are going to use this section to install TLJH directly into our Virtual Machine. @@ -177,7 +169,6 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest 12. Check the summary and confirm the creation of your Virtual Machine. 13. Check that the creation of your Virtual Machine worked. - - Wait for the virtual machine to be created. This might take about 5-10 minutes. - After completion, you should see a similar screen to the one below: diff --git a/docs/install/jetstream.md b/docs/install/jetstream.md index ae9060c..9d5223b 100644 --- a/docs/install/jetstream.md +++ b/docs/install/jetstream.md @@ -34,9 +34,9 @@ We'll create a new Jetstream2 instance: 3. SSH into the instance with the `exouser` user: - ```bash - ssh exouser@yourinstancename.xxx0000000.projects.jetstream-cloud.org - ``` + ```bash + ssh exouser@yourinstancename.xxx0000000.projects.jetstream-cloud.org + ``` 4. Run the TLJH bootstrap script: @@ -44,7 +44,7 @@ We'll create a new Jetstream2 instance: curl -L https://tljh.jupyter.org/bootstrap.py | sudo -E python3 - --admin ``` -5. Open the Hostname in a web browser (http on port 80). You should see the JupyterHub login page. Your browser will warn about the site not being secure (no HTTPS)—we'll enable HTTPS in the next step. Do not login yet, first setup HTTPS, so we avoid transmitting the password in clear text. +5. Open the Hostname in a web browser (http on port 80). You should see the JupyterHub login page. Your browser will warn about the site not being secure (no HTTPS)—we'll enable HTTPS in the next step. Do not login yet, first setup HTTPS, so we avoid transmitting the password in clear text. ## Step 2: Enable HTTPS diff --git a/docs/topic/whentouse.md b/docs/topic/whentouse.md index d404da3..010c5dc 100644 --- a/docs/topic/whentouse.md +++ b/docs/topic/whentouse.md @@ -22,11 +22,9 @@ container technology in administering user sessions. The choice between TLJH and Z2JH ultimately comes down to only a few questions: 1. Do you want your hub and all users to live on a **single, larger machine** vs. spreading users on a **cluster of smaller machines** that are scaled up or down? - - If you can use a single machine, we recommend **The Littlest JupyterHub**. - If you wish to use multiple machines, we recommend **Zero to JupyterHub for Kubernetes**. 2. Do you **need to use container technology**? - - If no, we recommend **The Littlest JupyterHub**. - If yes, we recommend **Zero to JupyterHub for Kubernetes**. diff --git a/docs/troubleshooting/logs.md b/docs/troubleshooting/logs.md index b488494..e7c968d 100644 --- a/docs/troubleshooting/logs.md +++ b/docs/troubleshooting/logs.md @@ -81,7 +81,6 @@ easier. Here are some very basic tips on effective `journalctl` usage. [less](). This allows you to scroll up / down, search for specific words, etc. Some common keyboard shortcuts are: - - Arrow keys to move up / down / left / right - `G` to navigate to the end of the logs - `g` to navigate to the start of the logs