docs/index.rst

The Littlest JupyterHub
-----------------------

A simple `JupyterHub <https://github.com/jupyterhub/jupyterhub>`_ distribution for
a small (0-50) number of users on a single server.

Tutorials
=========

Tutorials guide you through accomplishing specific goals. Great place to get
started!

.. toctree::
   :titlesonly:

   tutorials/digitalocean
   tutorials/jetstream
   tutorials/google

Guides
======

Guides provide in-depth explanations of specific topics.

.. toctree::
   :titlesonly:

   guides/requirements
   guides/install
   guides/admin
   guides/user-environment
   guides/notebook-interfaces

Troubleshooting
===============

In time, all systems have issues that need to be debugged. Troubleshooting
guides help you find what is broken & hopefully fix it.

.. toctree::
   :titlesonly:

   troubleshooting/logs

Contributing
============

We want you to contribute to TLJH in the ways that are most useful
and exciting to you. This section contains documentation helpful
to people contributing in various ways.

.. toctree::
   :titlesonly:

   contributing/docs
   contributing/dev-setup
Switch to sphinx+rtd for documentation - mkdocs doesn't support GFMD, so is a different dialect - recommonmark seems abandoned - Couldn't get m2r to work So RST + Sphinx it is! 2018-06-28 00:39:55 -07:00			`The Littlest JupyterHub`
			`-----------------------`

			A simple `JupyterHub <https://github.com/jupyterhub/jupyterhub>`_ distribution for
			`a small (0-50) number of users on a single server.`

Add a quickstart tutorial & re-organize index page We split docs into tutorials & more in-depth guides. 2018-06-28 02:34:51 -07:00			`Tutorials`
			`=========`

			`Tutorials guide you through accomplishing specific goals. Great place to get`
			`started!`

			`.. toctree::`
			`:titlesonly:`

Add a digitalocean quickstart - Remove generic quickstart for now 2018-07-03 18:22:52 -07:00			`tutorials/digitalocean`
Add a JetStream tutorial 2018-07-03 21:37:42 -07:00			`tutorials/jetstream`
Add Google Cloud tutorial to index page 2018-07-05 14:41:03 -07:00			`tutorials/google`
Add a quickstart tutorial & re-organize index page We split docs into tutorials & more in-depth guides. 2018-06-28 02:34:51 -07:00
			`Guides`
			`======`

			`Guides provide in-depth explanations of specific topics.`

Switch to sphinx+rtd for documentation - mkdocs doesn't support GFMD, so is a different dialect - recommonmark seems abandoned - Couldn't get m2r to work So RST + Sphinx it is! 2018-06-28 00:39:55 -07:00			`.. toctree::`
Add a quickstart tutorial & re-organize index page We split docs into tutorials & more in-depth guides. 2018-06-28 02:34:51 -07:00			`:titlesonly:`
Switch to sphinx+rtd for documentation - mkdocs doesn't support GFMD, so is a different dialect - recommonmark seems abandoned - Couldn't get m2r to work So RST + Sphinx it is! 2018-06-28 00:39:55 -07:00
Add a quickstart tutorial & re-organize index page We split docs into tutorials & more in-depth guides. 2018-06-28 02:34:51 -07:00			`guides/requirements`
			`guides/install`
			`guides/admin`
Add guide for customizing user environments 2018-06-28 15:41:15 -07:00			`guides/user-environment`
Add guide on picking a notebook interface 2018-06-29 01:11:21 -07:00			`guides/notebook-interfaces`
Add a troubleshooting section 2018-06-28 13:05:57 -07:00
			`Troubleshooting`
			`===============`

			`In time, all systems have issues that need to be debugged. Troubleshooting`
			`guides help you find what is broken & hopefully fix it.`

			`.. toctree::`
			`:titlesonly:`

			`troubleshooting/logs`
Add docs for setting up a developer environment 2018-06-28 18:26:47 -07:00
			`Contributing`
			`============`

Reword contributing section in index.rst 2018-06-29 01:35:19 -07:00			`We want you to contribute to TLJH in the ways that are most useful`
			`and exciting to you. This section contains documentation helpful`
			`to people contributing in various ways.`
Add docs for setting up a developer environment 2018-06-28 18:26:47 -07:00
			`.. toctree::`
			`:titlesonly:`

Add documentation guidelines 2018-07-10 10:21:53 -07:00			`contributing/docs`
Add docs for setting up a developer environment 2018-06-28 18:26:47 -07:00			`contributing/dev-setup`