From de1fe2abe13c3297801a531a42124498b937012b Mon Sep 17 00:00:00 2001 From: Chris Holdgraf Date: Fri, 26 Apr 2019 10:55:42 -0700 Subject: [PATCH 1/6] adding sidebar links --- docs/_static/custom.css | 4 ++-- docs/conf.py | 4 ++++ docs/index.rst | 8 ++++++++ 3 files changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 72c470f..a873ff6 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -1,3 +1,3 @@ -div.sphinxsidebarwrapper h1.logo { - font-size: 2.3rem; +div.toctree-wrapper p.caption { + display: none; } diff --git a/docs/conf.py b/docs/conf.py index 4a2ab51..5836ae6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -56,6 +56,7 @@ if os.path.exists(os.path.join(here, '_static')): html_sidebars = { '**': [ 'about.html', + 'globaltoc.html', 'relations.html', 'searchbox.html', 'donate.html', @@ -74,3 +75,6 @@ html_theme_options = { 'github_banner': False, 'github_type': 'star', } + +def setup(app): + app.add_stylesheet('custom.css') \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 0dd4fdc..a4cd719 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -28,6 +28,7 @@ We have a bunch of tutorials to get you started. .. toctree:: :titlesonly: + :caption: Installation install/digitalocean install/jetstream @@ -48,6 +49,7 @@ Content and Data .. toctree:: :titlesonly: + :caption: Content and data howto/content/nbgitpuller howto/content/add-data @@ -58,6 +60,7 @@ The user environment .. toctree:: :titlesonly: + :caption: The user environment howto/env/user-environment howto/env/notebook-interfaces @@ -72,6 +75,7 @@ with your JupyterHub. For more information on Authentication, see .. toctree:: :titlesonly: + :caption: Authentication howto/auth/dummy howto/auth/github @@ -83,6 +87,7 @@ Administration and security .. toctree:: :titlesonly: + :caption: Administration and security howto/admin/admin-users howto/admin/resource-estimation @@ -99,6 +104,7 @@ Topic guides provide in-depth explanations of specific topics. .. toctree:: :titlesonly: + :caption: Topic guides topic/whentouse topic/requirements @@ -118,6 +124,7 @@ guides help you find what is broken & hopefully fix it. .. toctree:: :titlesonly: + :caption: Troubleshooting troubleshooting/logs @@ -142,6 +149,7 @@ to people contributing in various ways. .. toctree:: :titlesonly: + :caption: Contributing contributing/docs contributing/code-review From edd2f471c73f368321b29b92b0c8fa549e0d7ab9 Mon Sep 17 00:00:00 2001 From: yuvipanda Date: Tue, 30 Apr 2019 12:29:01 -0700 Subject: [PATCH 2/6] Bump JupyterHub and systemdspawner versions --- tljh/installer.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tljh/installer.py b/tljh/installer.py index 6d07f84..91395cf 100644 --- a/tljh/installer.py +++ b/tljh/installer.py @@ -189,9 +189,9 @@ def ensure_jupyterhub_package(prefix): and conda packages! """ conda.ensure_pip_packages(prefix, [ - 'jupyterhub==0.9.5', + 'jupyterhub==0.9.6', 'jupyterhub-dummyauthenticator==0.3.1', - 'jupyterhub-systemdspawner==0.11', + 'jupyterhub-systemdspawner==0.13', 'jupyterhub-firstuseauthenticator==0.12', 'jupyterhub-nativeauthenticator==0.0.4', 'jupyterhub-ldapauthenticator==1.2.2', @@ -242,7 +242,7 @@ def ensure_user_environment(user_requirements_txt_file): conda.ensure_pip_packages(USER_ENV_PREFIX, [ # JupyterHub + notebook package are base requirements for user environment - 'jupyterhub==0.9.5', + 'jupyterhub==0.9.6', 'notebook==5.7.8', # Install additional notebook frontends! 'jupyterlab==0.35.4', From 86f1ed3a0ea13b7e368c6563a535851b99696f5e Mon Sep 17 00:00:00 2001 From: shireenrao Date: Thu, 9 May 2019 09:07:14 -0400 Subject: [PATCH 3/6] Update Readme for the AWS docs link Fixed the link for AWS docs to point to the right location. --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index cc7c365..c8ddc30 100644 --- a/README.rst +++ b/README.rst @@ -45,7 +45,7 @@ Ubuntu 18.04. We have a bunch of tutorials to get you started! - `Digital Ocean `_ - `Google Cloud `_ - `Jetstream `_ - - `Amazon Web Services `_ + - `Amazon Web Services `_ - ... your favorite provider here, if you can contribute! - `Tutorial to install TLJH on an already running server you have root access to From 3af53522aa1ff8f8148561028b4ee318a0ed84b6 Mon Sep 17 00:00:00 2001 From: yuvipanda Date: Thu, 9 May 2019 13:08:02 -0700 Subject: [PATCH 4/6] Remove ominous warning with outdated release date Aug '18 has come and gone, and people have been using TLJH to great effect for a while. Reflect that in 'development status' --- docs/index.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index a4cd719..1b7393c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,10 +10,9 @@ a small (0-100) number of users on a single server. We recommend reading Development Status ================== -This project is currently in **alpha** state. Most things work, but we might -still make breaking changes that have no clear upgrade pathway. We are targeting -a v0.1 release sometime in mid-August 2018. Follow `this milestone `_ -to see progress towards the release! +This project is currently in **beta** state. Folks have been using installations +of TLJH for more than a year now to great success. While we try hard not to, we +might still make breaking changes that have no clear upgrade pathway. Installation ============ From b1c9a9f37a518accf1ce8b94d696f338bf79c3cb Mon Sep 17 00:00:00 2001 From: yuvipanda Date: Thu, 9 May 2019 12:53:06 -0700 Subject: [PATCH 5/6] Move digital ocean 'resize' docs out of 'install' step Since you usually don't want to resize right after you create a VM, I've moved it to a more central 'cloud provider tasks' page. We can add additional things here too. It matches similar provider specific pages we have for troubleshooting --- docs/howto/admin/resize.rst | 4 +-- docs/howto/providers/digitalocean.rst | 43 +++++++++++++++++++++++++++ docs/index.rst | 8 +++++ docs/install/digitalocean.rst | 38 +---------------------- 4 files changed, 53 insertions(+), 40 deletions(-) create mode 100644 docs/howto/providers/digitalocean.rst diff --git a/docs/howto/admin/resize.rst b/docs/howto/admin/resize.rst index d0e9548..8cf1043 100644 --- a/docs/howto/admin/resize.rst +++ b/docs/howto/admin/resize.rst @@ -13,13 +13,11 @@ the cloud provider of your choice. Currently there are instructions to resize your resources on the following providers: -* :ref:`Digital Ocean `. +* :ref:`Digital Ocean `. Once resources have been reallocated, you must tell TLJH to make use of these resources, and verify that the resources have become available. -.. _tljhconf: - Verifying a Resize ================== diff --git a/docs/howto/providers/digitalocean.rst b/docs/howto/providers/digitalocean.rst new file mode 100644 index 0000000..081ad91 --- /dev/null +++ b/docs/howto/providers/digitalocean.rst @@ -0,0 +1,43 @@ +.. _howto/providers/digitalocean: + +================================================ +Perform common Digital Ocean configuration tasks +================================================ + +This page lists various common tasks you can perform on your +Digital Ocean virtual machine. + +.. _howto/providers/digitalocean/resize: + +Resizing your droplet +===================== + +As you use your JupyterHub, you may find that you need more memory, +disk space, or CPUs. Digital Ocean servers can be resized in the +"Resize Droplet" panel. These instructions take you through the process. + +#. First, click on the name of your newly-created + Droplet to enter its configuration page. + +#. Next, **turn off your Droplet**. This allows DigitalOcean to make + modifications to your VM. This will shut down your JupyterHub (temporarily). + + .. image:: ../../images/providers/digitalocean/power-off.png + :alt: Power off your Droplet + :width: 200px + +#. Once your Droplet has been turned off, click "Resize", + which will take you to a menu with options to resize your VM. + + .. image:: ../../images/providers/digitalocean/resize-droplet.png + :alt: Resize panel of digital ocean + +#. Decide what kinds of resources you'd like to resize, then click on a new VM + type in the list below. Finally, click "Resize". This may take a few moments! + +#. Once your Droplet is resized, **turn your Droplet back on**. This makes your JupyterHub + available to the world once again. This will take a few moments to complete. + +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`. \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index a4cd719..8993aaf 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -96,6 +96,14 @@ Administration and security howto/admin/https howto/admin/enable-extensions +Cloud provider configuration +---------------------------- + +.. toctree:: + :titlesonly: + :caption: Cloud provider configuration + + howto/providers/digitalocean Topic Guides ============ diff --git a/docs/install/digitalocean.rst b/docs/install/digitalocean.rst index a4e316e..6d07e35 100644 --- a/docs/install/digitalocean.rst +++ b/docs/install/digitalocean.rst @@ -116,40 +116,4 @@ Step 2: Adding more users Step 3: Install conda / pip packages for all users ================================================== -.. include:: add_packages.txt - -.. _digitalocean/resize: - -Step 4: Resizing and editing the droplet -======================================== - -As you use your JupyterHub, you may find that you need more memory, -disk space, or CPUs. Digital Ocean servers can be resized in the -"Resize Droplet" panel. These instructions take you through the process. - -#. First, click on the name of your newly-created - Droplet to enter its configuration page. - -#. Next, **turn off your Droplet**. This allows DigitalOcean to make - modifications to your VM. This will shut down your JupyterHub (temporarily). - - .. image:: ../images/providers/digitalocean/power-off.png - :alt: Power off your Droplet - :width: 200px - -#. Once your Droplet has been turned off, click "Resize", - which will take you to a menu with options to resize your VM. - - .. image:: ../images/providers/digitalocean/resize-droplet.png - :alt: Resize panel of digital ocean - -#. Decide what kinds of resources you'd like to resize, then click on a new VM - type in the list below. Finally, click "Resize". This may take a few moments! - -#. Once your Droplet is resized, **turn your Droplet back on**. This makes your JupyterHub - available to the world once again. This will take a few moments to complete. - -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`. - +.. include:: add_packages.txt \ No newline at end of file From cecfb7ba4d02424b65d63916ec4c042a4bb9cd73 Mon Sep 17 00:00:00 2001 From: Mayeul Cantan Date: Wed, 15 May 2019 17:49:09 +0200 Subject: [PATCH 6/6] Remove repeated sentence from README.rst --- README.rst | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index c8ddc30..276fdb9 100644 --- a/README.rst +++ b/README.rst @@ -16,10 +16,8 @@ to 1-50 users on a single server. Administrators who do not consider themselves 'system administrators' but would like to provide hosted Jupyter Notebooks for their students / users are the -primary audience. All users get the same environment, and administrators can -install libraries into this environment without any specialized knowledge. -It provides all users with the same environment, and administrators can install -libraries into this environment easily without any specialized knowledge. +primary audience. All users are provided with the same environment, and administrators +can easily install libraries into this environment without any specialized knowledge. See `this blog post `_ for more information.