docs/index.rst

=======================
The Littlest JupyterHub
=======================

A simple `JupyterHub <https://github.com/jupyterhub/jupyterhub>`_ distribution for
a small (0-100) number of users on a single server. We recommend reading
:ref:`topic/whentouse` to determine if this is the right tool for you.


Development Status
==================

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
============

The Littlest JupyterHub (TLJH) can run on any server that is running **Debian 10** or **Ubuntu 20.04** on a amd64 or arm64 CPU architecture. Earlier versions of Ubuntu and Debian are not supported, as are other Linux distributions.
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:
     :maxdepth: 2

     install/index

Once you are ready to run your server for real,
it's a good idea to proceed directly to :doc:`howto/admin/https`.

How-To Guides
=============

How-To guides answer the question 'How do I...?' for a lot of topics.

.. toctree::
   :maxdepth: 2

   howto/index

Topic Guides
============

Topic guides provide in-depth explanations of specific topics.

.. toctree::
   :titlesonly:
   :maxdepth: 2

   topic/index


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:
   :maxdepth: 2

   troubleshooting/index

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:
   :maxdepth: 2

   contributing/index
Normalize heading levels to match documentation guidelines 2018-07-10 11:35:18 -07:00			`=======================`
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`
Normalize heading levels to match documentation guidelines 2018-07-10 11:35:18 -07:00			`=======================`
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
			A simple `JupyterHub <https://github.com/jupyterhub/jupyterhub>`_ distribution for
adding when to use tljh page 2018-08-08 10:18:20 -07:00			`a small (0-100) number of users on a single server. We recommend reading`
			:ref:`topic/whentouse` to determine if this is the right tool for you.
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
Provide better error message when running on unsupported distro 2018-10-30 20:08:47 -07:00
Add security topic guide Fixes #13 2018-07-12 14:15:01 -07:00			`Development Status`
			`==================`

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' 2019-05-09 13:08:02 -07:00			`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.`
Add security topic guide Fixes #13 2018-07-12 14:15:01 -07:00
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 2018-07-11 12:00:58 -07:00			`Installation`
			`============`

require ubuntu 20.04, test on debian 10 2023-03-21 10:15:22 +01:00			`The Littlest JupyterHub (TLJH) can run on any server that is running Debian 10 or Ubuntu 20.04 on a amd64 or arm64 CPU architecture. Earlier versions of Ubuntu and Debian are not supported, as are other Linux distributions.`
Provide better error message when running on unsupported distro 2018-10-30 20:08:47 -07:00			`We have a bunch of tutorials to get you started.`
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 2018-07-11 12:00:58 -07:00
			`- 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:`
updating index files 2019-11-26 18:42:42 -08:00			`:maxdepth: 2`
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 2018-07-11 12:00:58 -07:00
updating index files 2019-11-26 18:42:42 -08:00			`install/index`
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 2018-07-11 12:00:58 -07:00
docs for setting up HTTPS 2018-07-30 16:08:47 +02:00			`Once you are ready to run your server for real,`
updating content from zexuan's user test 2018-08-10 10:09:24 -07:00			it's a good idea to proceed directly to :doc:`howto/admin/https`.
docs for setting up HTTPS 2018-07-30 16:08:47 +02:00
updating content from zexuan's user test 2018-08-10 10:09:24 -07:00			`How-To Guides`
			`=============`

			`How-To guides answer the question 'How do I...?' for a lot of topics.`
Add tutorial for nbgitpuller Fixes #50 2018-07-26 23:47:07 -07:00
Move user-environment howto to how-to section 2018-07-10 14:39:26 -07:00			`.. toctree::`
updating index files 2019-11-26 18:42:42 -08:00			`:maxdepth: 2`
Move user-environment howto to how-to section 2018-07-10 14:39:26 -07:00
updating index files 2019-11-26 18:42:42 -08:00			`howto/index`
Add howto doc on dummy authenticator 2018-07-27 22:22:45 -07:00
Add security topic guide Fixes #13 2018-07-12 14:15:01 -07:00			`Topic Guides`
			`============`
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
Add security topic guide Fixes #13 2018-07-12 14:15:01 -07:00			`Topic guides provide in-depth explanations of specific topics.`
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
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:`
updating index files 2019-11-26 18:42:42 -08:00			`:maxdepth: 2`
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
updating index files 2019-11-26 18:42:42 -08:00			`topic/index`
Add security topic guide Fixes #13 2018-07-12 14:15:01 -07:00
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:`
updating index files 2019-11-26 18:42:42 -08:00			`:maxdepth: 2`
Add docs for setting up a developer environment 2018-06-28 18:26:47 -07:00
updating index files 2019-11-26 18:42:42 -08:00			`troubleshooting/index`
Add troubleshooting guide for google cloud 2018-07-11 13:34:12 -07:00
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:`
updating index files 2019-11-26 18:42:42 -08:00			`:maxdepth: 2`

			`contributing/index`