Cleanup installation instructions in documentation

- Make it clear these are installation instructions for
  various cloud providers & custom servers
- Simplify titles of the installation tutorials

Fixes #17
This commit is contained in:
yuvipanda
2018-07-11 12:00:58 -07:00
parent bd122ef218
commit 40667c15a4
5 changed files with 35 additions and 16 deletions

View File

@@ -5,6 +5,27 @@ The Littlest JupyterHub
A simple `JupyterHub <https://github.com/jupyterhub/jupyterhub>`_ distribution for A simple `JupyterHub <https://github.com/jupyterhub/jupyterhub>`_ distribution for
a small (0-50) number of users on a single server. a small (0-50) number of users on a single server.
Installation
============
The Littlest JupyterHub (TLJH) can run on any server that is running at least
Ubuntu 18.04. We have a bunch of 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.
.. toctree::
:titlesonly:
tutorials/digitalocean
tutorials/jetstream
tutorials/google
- :ref:`tutorial/custom`.
You should use this if your cloud provider does not already have a direct tutorial,
or if you have experience setting up servers.
Tutorials Tutorials
========= =========

View File

@@ -1,8 +1,8 @@
.. _tutorial_quickstart_custom: .. _tutorials/custom:
======================================= =============================
Tutorial: JupyterHub on your own server Installing on your own server
======================================= =============================
Goal Goal
==== ====

View File

@@ -1,8 +1,8 @@
.. _tutorial_quickstart_digitalocean: .. _tutorial_quickstart_digitalocean:
===================================== ===========================
Tutorial: JupyterHub on Digital Ocean Installing on Digital Ocean
===================================== ===========================
Goal Goal
==== ====
@@ -15,7 +15,6 @@ Pre-requisites
============== ==============
#. A DigitalOcean account with a payment method attached. #. A DigitalOcean account with a payment method attached.
#. Some familiarity with the command line.
Step 1: Installing The Littlest JupyterHub Step 1: Installing The Littlest JupyterHub
========================================== ==========================================

View File

@@ -1,8 +1,8 @@
.. _tutorial_quickstart_google: .. _tutorial_quickstart_google:
==================================== ==========================
Tutorial: JupyterHub on Google Cloud Installing on Google Cloud
==================================== ==========================
Goal Goal
==== ====

View File

@@ -1,8 +1,8 @@
.. _tutorial_quickstart_jetstream: .. _tutorial_quickstart_jetstream:
================================= =======================
Tutorial: JupyterHub on Jetstream Installing on Jetstream
================================= =======================
Goal Goal
==== ====
@@ -15,8 +15,7 @@ Prerequisites
============= =============
#. A Jetstream account with an XSEDE allocation; for more information, #. A Jetstream account with an XSEDE allocation; for more information,
go to the `Jetstream Allocations help page <http://wiki.jetstream-cloud.org/Jetstream+Allocations>`_. see the `Jetstream Allocations help page <http://wiki.jetstream-cloud.org/Jetstream+Allocations>`_.
#. Some familiarity with the command line.
Step 1: Installing The Littlest JupyterHub Step 1: Installing The Littlest JupyterHub
========================================== ==========================================