From eb6bf3f698b7108bddb8bb5f8b4cd670b87011ac Mon Sep 17 00:00:00 2001 From: Melissa Kirabo Date: Tue, 11 Oct 2022 10:06:24 +0300 Subject: [PATCH 1/6] Update index.rst I have made some changes to the flow of the documentation, added descriptions, and corrected grammatical errors --- docs/source/index.rst | 71 ++++++++++++++++++++++--------------------- 1 file changed, 36 insertions(+), 35 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index a7b2c0c8..b13de164 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,32 +1,28 @@ ========== JupyterHub ========== - `JupyterHub`_ is the best way to serve `Jupyter notebook`_ for multiple users. -It can be used in a class of students, a corporate data science group or scientific -research group. It is a multi-user **Hub** that spawns, manages, and proxies multiple -instances of the single-user `Jupyter notebook`_ server. +It is a multi-user **Hub** that spawns, manages, and proxies multiple instances +of the single-user `Jupyter notebook`_ server. Therefore, with JupyterHub, +users can log in to the server, and write Python code in a web browser, +without having to install software on their local machine. -To make life easier, JupyterHub has distributions. Be sure to -take a look at them before continuing with the configuration of the broad -original system of `JupyterHub`_. Today, you can find two main cases: +JupyterHub supports web browsers, tablets and smartphones and can be used by +multiple users at the same time such as; a class of students, a corporate data +science group or scientific research group. +JupyterHub makes life easier by enabling collaboration between both small (0-100 users) and +large teams (more than 100 users). It has distributions which are developed to serve the needs +of each of these teams respectively. -1. If you need a simple case for a small amount of users (0-100) and single server - take a look at - `The Littlest JupyterHub `__ distribution. -2. If you need to allow for even more users, a dynamic amount of servers can be used on a cloud, - take a look at the `Zero to JupyterHub with Kubernetes `__ . +JupyterHub is made up of four subsystems: +* 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 +* 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 -Four subsystems make up 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 -* 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 - - -Besides these central pieces, you can add optional configurations through a `config.py` file and manage users kernels on an admin panel. A simplification of the whole system can be seen in the figure below: +Additionally, optional configurations can be added through a `config.py` file and manage users +kernels on an admin panel. A simplification of the whole system is displayed in the figure below: .. image:: images/jhub-fluxogram.jpeg :alt: JupyterHub subsystems @@ -56,17 +52,23 @@ Contents Distributions ------------- -A JupyterHub **distribution** is tailored towards a particular set of -use cases. These are generally easier to set up than setting up -JupyterHub from scratch, assuming they fit your use case. +As earlier mentioned, a JupyterHub **distribution** is tailored +towards a particular set of use cases. These are generally easier +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: + +1. If you need a simple case for a small amount of users (0-100) and single server + take a look at + `The Littlest JupyterHub `__ distribution. +2. If you need to allow for a larger number of machines and users, + a dynamic amount of servers can be used on a cloud, + take a look at the `Zero to JupyterHub with Kubernetes `__ distribution. + This distribution runs JupyterHub on top of `Kubernetes `_. + +*It is important to evaluate these distributions before you can continue with the +configuration of the broad original system of* **JupyterHub**. -* `Zero to JupyterHub on Kubernetes `_, for - running JupyterHub on top of `Kubernetes `_. This - can scale to large number of machines & users. -* `The Littlest JupyterHub `_, for an easy - to set up & run JupyterHub supporting 1-100 users on a single machine. Installation Guide ------------------ @@ -123,9 +125,8 @@ We want you to contribute to JupyterHub in ways that are most exciting & useful to you. We value documentation, testing, bug reporting & code equally, and are glad to have your contributions in whatever form you wish :) -Our `Code of Conduct `_ -(`reporting guidelines `_) -helps keep our community welcoming to as many people as possible. +Our `Code of Conduct `_ and `reporting guidelines `_ +help keep our community welcoming to as many people as possible. .. toctree:: :maxdepth: 2 @@ -149,9 +150,9 @@ Indices and tables Questions? Suggestions? ======================= +All questions and suggestions are welcome. Please feel free to use our `Jupyter mailing list `_ and `Jupyter website `_ to contact our team. -- `Jupyter mailing list `_ -- `Jupyter website `_ +Looking forward to hearing from you! .. _JupyterHub: https://github.com/jupyterhub/jupyterhub .. _Jupyter notebook: https://jupyter-notebook.readthedocs.io/en/latest/ From ec18f7b65ab3e16df2f37b043e84fc19a85da26d Mon Sep 17 00:00:00 2001 From: Melissa Kirabo Date: Fri, 21 Oct 2022 11:04:04 +0300 Subject: [PATCH 2/6] Update docs/source/index.rst Co-authored-by: Min RK --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 6bd4864d..4cf71a28 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -15,7 +15,7 @@ original system of `JupyterHub`_. As of now, you can find two main cases: 2. `Zero to JupyterHub with Kubernetes `__ allows you to deploy dynamic servers on the cloud if you need even more users. JupyterHub supports web browsers, tablets and smartphones and can be used by -multiple users at the same time such as; a class of students, a corporate data +multiple users at the same time such as a class of students, corporate data science group or scientific research group. JupyterHub makes life easier by enabling collaboration between both small (0-100 users) and large teams (more than 100 users). It has distributions which are developed to serve the needs From 42918352a8bd89187d79e6f1f0bbb7abe22f913a Mon Sep 17 00:00:00 2001 From: Melissa Kirabo Date: Fri, 21 Oct 2022 11:06:55 +0300 Subject: [PATCH 3/6] Update docs/source/index.rst Co-authored-by: Min RK --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 4cf71a28..d08ca076 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -59,7 +59,7 @@ Contents Distributions ------------- -As earlier mentioned, a JupyterHub **distribution** is tailored +A JupyterHub **distribution** is tailored towards a particular set of use cases. These are generally easier to set up than setting up JupyterHub from scratch, assuming they fit your use case. From 037943728f4cb7d9148cf6c44afbc1bf8cb84d3a Mon Sep 17 00:00:00 2001 From: Melissa Kirabo Date: Fri, 21 Oct 2022 11:07:44 +0300 Subject: [PATCH 4/6] Update docs/source/index.rst Co-authored-by: Min RK --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index d08ca076..0c2a9511 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -74,7 +74,7 @@ Today, you can find two main use cases: This distribution runs JupyterHub on top of `Kubernetes `_. *It is important to evaluate these distributions before you can continue with the -configuration of the broad original system of* **JupyterHub**. +configuration of JupyterHub*. Installation Guide ------------------ From 7330babc7e4a501fc629aaf43fb70cec007de000 Mon Sep 17 00:00:00 2001 From: Melissa Kirabo Date: Fri, 21 Oct 2022 11:34:12 +0300 Subject: [PATCH 5/6] Update index.rst --- docs/source/index.rst | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 0c2a9511..fb1cadf2 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -7,9 +7,7 @@ it can be used in a class of students, a corporate data science group, or a scie research group. It is a multi-user **Hub** that spawns, manages, and proxies multiple instances of the single-user `Jupyter notebook`_ server. -JupyterHub offers distributions for different use cases. Be sure to -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: +JupyterHub offers distributions for different use cases. As of now, you can find two main cases: 1. `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 `__ allows you to deploy dynamic servers on the cloud if you need even more users. @@ -17,16 +15,16 @@ original system of `JupyterHub`_. As of now, you can find two main cases: JupyterHub supports web browsers, tablets and smartphones and can be used by multiple users at the same time such as a class of students, corporate data science group or scientific research group. -JupyterHub makes life easier by enabling collaboration between both small (0-100 users) and +JupyterHub can be used in a collaborative environment by both both small (0-100 users) and large teams (more than 100 users). 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 **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 -* An **authentication class** that manages how users can access the system +* 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 +* 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 Additionally, optional configurations can be added through a `config.py` file and manage users kernels on an admin panel. A simplification of the whole system is displayed in the figure below: @@ -156,7 +154,7 @@ Indices and tables Questions? Suggestions? ======================= -All questions and suggestions are welcome. Please feel free to use our `Jupyter mailing list `_ and `Jupyter website `_ to contact our team. +All questions and suggestions are welcome. Please feel free to use our `Jupyter Discourse Forum `_ to contact our team. Looking forward to hearing from you! From 76f9cf00c404b2ab12e39fca24cdd6b645c4ccc3 Mon Sep 17 00:00:00 2001 From: Melissa Kirabo Date: Sat, 22 Oct 2022 10:55:50 +0300 Subject: [PATCH 6/6] Update index.rst --- docs/source/index.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index fb1cadf2..1624f090 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -12,12 +12,11 @@ JupyterHub offers distributions for different use cases. As of now, you can find 1. `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 `__ allows you to deploy dynamic servers on the cloud if you need even more users. -JupyterHub supports web browsers, tablets and smartphones and can be used by -multiple users at the same time such as a class of students, corporate data -science group or scientific research group. + JupyterHub can be used in a collaborative environment by both both small (0-100 users) and -large teams (more than 100 users). It has distributions which are developed to serve the needs -of each of these teams respectively. +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: