From 1ac6f9983db2fd6c8905282981aa904455c0c3ba Mon Sep 17 00:00:00 2001 From: Min RK Date: Mon, 27 Mar 2023 10:22:35 +0200 Subject: [PATCH] markdownify add_users/packages included files not caught in initial rst2myst --- docs/install/add_packages.txt | 60 ++++++++++++------------- docs/install/add_users.txt | 82 ++++++++++++++++++----------------- docs/install/amazon.md | 8 ++-- docs/install/azure.md | 8 ++-- docs/install/custom-server.md | 8 ++-- docs/install/digitalocean.md | 8 ++-- docs/install/google.md | 8 ++-- docs/install/jetstream.md | 8 ++-- docs/install/ovh.md | 8 ++-- 9 files changed, 101 insertions(+), 97 deletions(-) diff --git a/docs/install/add_packages.txt b/docs/install/add_packages.txt index 56ad124..10f8972 100644 --- a/docs/install/add_packages.txt +++ b/docs/install/add_packages.txt @@ -1,30 +1,30 @@ -The **User Environment** is a conda environment that is shared by all users -in the JupyterHub. Libraries installed in this environment are immediately -available to all users. Admin users can install packages in this environment -with ``sudo -E``. - -#. Log in as an admin user and open a Terminal in your Jupyter Notebook. - - .. image:: ../images/notebook/new-terminal-button.png - :alt: New Terminal button under New menu - -#. Install `gdal `_ from `conda-forge `_. - - .. code-block:: bash - - sudo -E conda install -c conda-forge gdal - - The ``sudo -E`` is very important! - -#. Install `there `_ with ``pip`` - - - .. code-block:: bash - - sudo -E pip install there - -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. +The **User Environment** is a conda environment that is shared by all users +in the JupyterHub. Libraries installed in this environment are immediately +available to all users. Admin users can install packages in this environment +with `sudo -E`. + +1. Log in as an admin user and open a Terminal in your Jupyter Notebook. + + ```{image} ../images/notebook/new-terminal-button.png + :alt: New Terminal button under New menu + ``` + +2. Install [gdal](https://anaconda.org/conda-forge/gdal) from [conda-forge](https://conda-forge.org/). + + ```bash + sudo -E conda install -c conda-forge gdal + ``` + + The `sudo -E` is very important! + +3. Install [there](https://pypi.org/project/there) with `pip` + + ```bash + sudo -E pip install there + ``` + +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. diff --git a/docs/install/add_users.txt b/docs/install/add_users.txt index 8d4066f..53b137f 100644 --- a/docs/install/add_users.txt +++ b/docs/install/add_users.txt @@ -1,39 +1,43 @@ -Most administration & configuration of the JupyterHub can be done from the -web UI directly. Let's add a few users who can log in! - -#. Open the **Control Panel** by clicking the control panel button on the top - right of your JupyterHub. - - .. image:: ../images/control-panel-button.png - :alt: Control panel button in notebook, top right - -#. In the control panel, open the **Admin** link in the top left. - - .. image:: ../images/admin/admin-access-button.png - :alt: Admin button in control panel, top left - - This opens up the JupyterHub admin page, where you can add / delete users, - start / stop peoples' servers and see who is online. - -#. Click the **Add Users** button. - - .. image:: ../images/admin/add-users-button.png - :alt: Add Users button in the admin page - - A **Add Users** dialog box opens up. - -#. Type the names of users you want to add to this JupyterHub in the dialog box, - one per line. - - .. image:: ../images/admin/add-users-dialog.png - :alt: Adding users with add users dialog - - You can tick the **Admin** checkbox if you want to give admin rights to all - these users too. - -#. Click the **Add Users** button in the dialog box. Your users are now added - to the JupyterHub! When they log in for the first time, they can set their - password - and use it to log in again in the future. - -Congratulations, you now have a multi user JupyterHub that you can add arbitrary -users to! +Most administration & configuration of the JupyterHub can be done from the +web UI directly. Let's add a few users who can log in! + +1. Open the **Control Panel** by clicking the control panel button on the top + right of your JupyterHub. + + ```{image} ../images/control-panel-button.png + :alt: Control panel button in notebook, top right + ``` + +2. In the control panel, open the **Admin** link in the top left. + + ```{image} ../images/admin/admin-access-button.png + :alt: Admin button in control panel, top left + ``` + + This opens up the JupyterHub admin page, where you can add / delete users, + start / stop peoples' servers and see who is online. + +3. Click the **Add Users** button. + + ```{image} ../images/admin/add-users-button.png + :alt: Add Users button in the admin page + ``` + + A **Add Users** dialog box opens up. + +4. Type the names of users you want to add to this JupyterHub in the dialog box, + one per line. + + ```{image} ../images/admin/add-users-dialog.png + :alt: Adding users with add users dialog + ``` + + You can tick the **Admin** checkbox if you want to give admin rights to all + these users too. + +5. Click the **Add Users** button in the dialog box. Your users are now added + to the JupyterHub! When they log in for the first time, they can set their + password - and use it to log in again in the future. + +Congratulations, you now have a multi user JupyterHub that you can add arbitrary +users to! diff --git a/docs/install/amazon.md b/docs/install/amazon.md index 1c45ef1..227af91 100644 --- a/docs/install/amazon.md +++ b/docs/install/amazon.md @@ -268,12 +268,12 @@ Let's create the server on which we can run JupyterHub. ## Step 2: Adding more users -```{eval-rst} -.. include:: add_users.txt +```{include} add_users.txt + ``` ## Step 3: Install conda / pip packages for all users -```{eval-rst} -.. include:: add_packages.txt +```{include} add_packages.txt + ``` diff --git a/docs/install/azure.md b/docs/install/azure.md index e46d83d..087e158 100644 --- a/docs/install/azure.md +++ b/docs/install/azure.md @@ -207,12 +207,12 @@ A new screen with all the options for Virtual Machines in Azure will displayed. ## Step 2: Adding more users -```{eval-rst} -.. include:: add_users.txt +```{include} add_users.txt + ``` ## Step 3: Install conda / pip packages for all users -```{eval-rst} -.. include:: add_packages.txt +```{include} add_packages.txt + ``` diff --git a/docs/install/custom-server.md b/docs/install/custom-server.md index abb21cd..85760a9 100644 --- a/docs/install/custom-server.md +++ b/docs/install/custom-server.md @@ -79,14 +79,14 @@ for custom server installations. ## Step 2: Adding more users -```{eval-rst} -.. include:: add_users.txt +```{include} add_users.txt + ``` ## Step 3: Install conda / pip packages for all users -```{eval-rst} -.. include:: add_packages.txt +```{include} add_packages.txt + ``` ## Step 4: Setup HTTPS diff --git a/docs/install/digitalocean.md b/docs/install/digitalocean.md index 78f9ec4..c774ebd 100644 --- a/docs/install/digitalocean.md +++ b/docs/install/digitalocean.md @@ -112,12 +112,12 @@ Let's create the server on which we can run JupyterHub. ## Step 2: Adding more users -```{eval-rst} -.. include:: add_users.txt +```{include} add_users.txt + ``` ## Step 3: Install conda / pip packages for all users -```{eval-rst} -.. include:: add_packages.txt +```{include} add_packages.txt + ``` diff --git a/docs/install/google.md b/docs/install/google.md index b84bda1..8fd73d6 100644 --- a/docs/install/google.md +++ b/docs/install/google.md @@ -208,12 +208,12 @@ Let's create the server on which we can run JupyterHub. ## Step 2: Adding more users -```{eval-rst} -.. include:: add_users.txt +```{include} add_users.txt + ``` ## Step 3: Install conda / pip packages for all users -```{eval-rst} -.. include:: add_packages.txt +```{include} add_packages.txt + ``` diff --git a/docs/install/jetstream.md b/docs/install/jetstream.md index 680a43c..7205cf8 100644 --- a/docs/install/jetstream.md +++ b/docs/install/jetstream.md @@ -141,12 +141,12 @@ Let's create the server on which we can run JupyterHub. ## Step 2: Adding more users -```{eval-rst} -.. include:: add_users.txt +```{include} add_users.txt + ``` ## Step 3: Install conda / pip packages for all users -```{eval-rst} -.. include:: add_packages.txt +```{include} add_packages.txt + ``` diff --git a/docs/install/ovh.md b/docs/install/ovh.md index a979dba..2a562f6 100644 --- a/docs/install/ovh.md +++ b/docs/install/ovh.md @@ -122,12 +122,12 @@ Let's create the server on which we can run JupyterHub. ## Step 2: Adding more users -```{eval-rst} -.. include:: add_users.txt +```{include} add_users.txt + ``` ## Step 3: Install conda / pip packages for all users -```{eval-rst} -.. include:: add_packages.txt +```{include} add_packages.txt + ```