Merge pull request #4084 from melissakirabo/patch-1

Refine text in documentation index
This commit is contained in:
Min RK
2022-11-24 11:07:18 +01:00
committed by GitHub

View File

@@ -1,30 +1,32 @@
========== ==========
JupyterHub JupyterHub
========== ==========
`JupyterHub`_ is the best way to serve `Jupyter notebook`_ for multiple users. `JupyterHub`_ is the best way to serve `Jupyter notebook`_ for multiple users.
Because JupyterHub manages a separate Jupyter environment for each user, Because JupyterHub manages a separate Jupyter environment for each user,
it can be used in a class of students, a corporate data science group, or a scientific it can be used in a class of students, a corporate data science group, or a scientific
research group. It is a multi-user **Hub** that spawns, manages, and proxies multiple research group. It is a multi-user **Hub** that spawns, manages, and proxies multiple
instances of the single-user `Jupyter notebook`_ server. instances of the single-user `Jupyter notebook`_ server.
JupyterHub offers distributions for different use cases. Be sure to JupyterHub offers distributions for different use cases. As of now, you can find two main cases:
take a look at them before continuing with the configuration of the broad
original system of `JupyterHub`_. As of now, you can find two main cases:
1. `The Littlest JupyterHub <https://github.com/jupyterhub/the-littlest-jupyterhub>`__ distribution is suitable if you need a small number of users (1-100) and a single server with a simple environment. 1. `The Littlest JupyterHub <https://github.com/jupyterhub/the-littlest-jupyterhub>`__ distribution is suitable if you need a small number of users (1-100) and a single server with a simple environment.
2. `Zero to JupyterHub with Kubernetes <https://github.com/jupyterhub/zero-to-jupyterhub-k8s>`__ allows you to deploy dynamic servers on the cloud if you need even more users. 2. `Zero to JupyterHub with Kubernetes <https://github.com/jupyterhub/zero-to-jupyterhub-k8s>`__ allows you to deploy dynamic servers on the cloud if you need even more users.
Four subsystems make up JupyterHub: JupyterHub can be used in a collaborative environment by both both small (0-100 users) and
large teams (more than 100 users) such as a class of students, corporate data science group
or scientific research group. It has distributions which are developed to serve the needs of
each of these teams respectively.
JupyterHub is made up of four subsystems:
* a **Hub** (tornado process) that is the heart of JupyterHub * a **Hub** (tornado process) that is the heart of JupyterHub
* a **Configurable HTTP Proxy** (node-http-proxy) that receives the requests from the client's browser * a **configurable http proxy** (node-http-proxy) that receives the requests from the client's browser
* multiple **Single-User Jupyter Notebook Servers** (Python/IPython/tornado) that are monitored by Spawners * multiple **single-user Jupyter notebook servers** (Python/IPython/tornado) that are monitored by Spawners
* an **Authentication Class** that manages how users can access the system * an **authentication class** that manages how users can access the system
Additionally, optional configurations can be added through a `config.py` file and manage users
Besides these central pieces, you can add optional configurations through a `config.py` file and manage users' environments through an admin panel. A simplification of the whole system can be seen in the figure below: kernels on an admin panel. A simplification of the whole system is displayed in the figure below:
.. image:: images/jhub-fluxogram.jpeg .. image:: images/jhub-fluxogram.jpeg
:alt: JupyterHub subsystems :alt: JupyterHub subsystems
@@ -54,17 +56,22 @@ Contents
Distributions Distributions
------------- -------------
Each JupyterHub **distribution** is tailored toward a particular set of A JupyterHub **distribution** is tailored
use cases. These are generally easier to set up than setting up towards a particular set of use cases. These are generally easier
JupyterHub from scratch, assuming they fit your use case. to set up than setting up JupyterHub from scratch, assuming they fit your use case.
The two popular ones are: Today, you can find two main use cases:
* `The Littlest JupyterHub <http://tljh.jupyter.org>`_, for an easy 1. If you need a simple case for a small amount of users (0-100) and single server
to set up & run JupyterHub supporting 1-100 users on a single machine. take a look at
* `Zero to JupyterHub on Kubernetes <http://z2jh.jupyter.org>`_, for `The Littlest JupyterHub <https://github.com/jupyterhub/the-littlest-jupyterhub>`__ distribution.
running JupyterHub on top of `Kubernetes <https://k8s.io>`_. This 2. If you need to allow for a larger number of machines and users,
can scale to a large number of machines & users. a dynamic amount of servers can be used on a cloud,
take a look at the `Zero to JupyterHub with Kubernetes <https://github.com/jupyterhub/zero-to-jupyterhub-k8s>`__ distribution.
This distribution runs JupyterHub on top of `Kubernetes <https://k8s.io>`_.
*It is important to evaluate these distributions before you can continue with the
configuration of JupyterHub*.
Installation Guide Installation Guide
------------------ ------------------
@@ -121,9 +128,8 @@ We welcome you to contribute to JupyterHub in ways that are most exciting
& useful to you. We value documentation, testing, bug reporting & code equally & useful to you. We value documentation, testing, bug reporting & code equally
and are glad to have your contributions in whatever form you wish :) and are glad to have your contributions in whatever form you wish :)
Our `Code of Conduct <https://github.com/jupyter/governance/blob/HEAD/conduct/code_of_conduct.md>`_ Our `Code of Conduct <https://github.com/jupyter/governance/blob/HEAD/conduct/code_of_conduct.md>`_ and `reporting guidelines <https://github.com/jupyter/governance/blob/HEAD/conduct/reporting_online.md>`_
(`reporting guidelines <https://github.com/jupyter/governance/blob/HEAD/conduct/reporting_online.md>`_) help keep our community welcoming to as many people as possible.
helps keep our community welcoming to as many people as possible.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
@@ -147,9 +153,9 @@ Indices and tables
Questions? Suggestions? Questions? Suggestions?
======================= =======================
All questions and suggestions are welcome. Please feel free to use our `Jupyter Discourse Forum <https://discourse.jupyter.org/>`_ to contact our team.
- `Jupyter mailing list <https://groups.google.com/forum/#!forum/jupyter>`_ Looking forward to hearing from you!
- `Jupyter website <https://jupyter.org>`_
.. _JupyterHub: https://github.com/jupyterhub/jupyterhub .. _JupyterHub: https://github.com/jupyterhub/jupyterhub
.. _Jupyter notebook: https://jupyter-notebook.readthedocs.io/en/latest/ .. _Jupyter notebook: https://jupyter-notebook.readthedocs.io/en/latest/