diff --git a/docs/source/index.rst b/docs/source/index.rst index 331a3870..7b5d6aad 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,14 +3,71 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to JupyterHub's documentation! -====================================== +JupyterHub +========== + +.. note:: This is the official documentation for JupyterHub. This project is + under active development. + +JupyterHub is a multi-user server that manages and proxies multiple instances +of the single-user Jupyter notebook server. + +Three actors: + +* multi-user Hub (tornado process) +* configurable http proxy (node-http-proxy) +* multiple single-user IPython notebook servers (Python/IPython/tornado) + +Basic principles: + +* Hub spawns proxy +* Proxy forwards ~all requests to hub by default +* Hub handles login, and spawns single-user servers on demand +* Hub configures proxy to forward url prefixes to single-user servers + Contents: .. toctree:: - :maxdepth: 2 + :maxdepth: 1 + :caption: User Documentation + getting-started + how-it-works + +.. toctree:: + :maxdepth: 2 + :caption: Configuration + + authenticators + spawners + +.. toctree:: + :maxdepth: 1 + :caption: Developer Documentation + + + +.. toctree:: + :maxdepth: 1 + :caption: Community documentation + + + +.. toctree:: + :maxdepth: 2 + :caption: About JupyterHub + + changelog + +.. toctree:: + :maxdepth: 1 + :caption: Questions? Suggestions? + + Jupyter mailing list + Jupyter website + Stack Overflow - Jupyter + Stack Overflow - Jupyter-notebook Indices and tables