From b691480e5f404a7bff8ffc13aae74c91bef7ec80 Mon Sep 17 00:00:00 2001 From: alwasega Date: Fri, 20 Jan 2023 13:36:16 +0300 Subject: [PATCH 1/5] Added docs to the folder --- docs/source/index.md | 12 ++---------- docs/source/installation-guide.md | 13 ------------- docs/source/tutorial/index.md | 13 +++++++++++-- .../installation}/installation-basics.md | 0 .../installation}/quickstart-docker.md | 0 .../{ => tutorial/installation}/quickstart.md | 0 6 files changed, 13 insertions(+), 25 deletions(-) delete mode 100644 docs/source/installation-guide.md rename docs/source/{ => tutorial/installation}/installation-basics.md (100%) rename docs/source/{ => tutorial/installation}/quickstart-docker.md (100%) rename docs/source/{ => tutorial/installation}/quickstart.md (100%) diff --git a/docs/source/index.md b/docs/source/index.md index 90649789..6f468935 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -51,13 +51,13 @@ follows the Jupyter [Community Guides](https://jupyter.readthedocs.io/en/latest/ Documentation sections (reorganization in-progress) ```{toctree} -:maxdepth: 1 +:maxdepth: 2 -faq/index.md tutorial/index.md howto/index.md explanation/index.md reference/index.md +faq/index.md ``` (index/distributions)= @@ -81,14 +81,6 @@ Today, you can find two main use cases: _It is important to evaluate these distributions before you can continue with the configuration of JupyterHub_. -### Installation Guide - -```{toctree} -:maxdepth: 2 - -installation-guide -``` - ### Getting Started ```{toctree} diff --git a/docs/source/installation-guide.md b/docs/source/installation-guide.md deleted file mode 100644 index 011a796c..00000000 --- a/docs/source/installation-guide.md +++ /dev/null @@ -1,13 +0,0 @@ -# Installation - -These sections cover how to get up-and-running with JupyterHub. They cover -some basics of the tools needed to deploy JupyterHub as well as how to get it -running on your own infrastructure. - -```{toctree} -:maxdepth: 3 - -quickstart -quickstart-docker -installation-basics -``` diff --git a/docs/source/tutorial/index.md b/docs/source/tutorial/index.md index 14d6f1b3..9fa671d0 100644 --- a/docs/source/tutorial/index.md +++ b/docs/source/tutorial/index.md @@ -2,7 +2,16 @@ This section of the documentation provides step-by-step tutorials to help you achieve a specific goal. The tutorials should be a good place to start learning about JupyterHub and how it works. -```{toctree} -:maxdepth: 2 +## Installation +These sections cover how to get up-and-running with JupyterHub. They cover +some basics of the tools needed to deploy JupyterHub as well as how to get it +running on your own infrastructure. + +```{toctree} +:maxdepth: 1 + +installation/quickstart +installation/installation-basics +installation/quickstart-docker ``` diff --git a/docs/source/installation-basics.md b/docs/source/tutorial/installation/installation-basics.md similarity index 100% rename from docs/source/installation-basics.md rename to docs/source/tutorial/installation/installation-basics.md diff --git a/docs/source/quickstart-docker.md b/docs/source/tutorial/installation/quickstart-docker.md similarity index 100% rename from docs/source/quickstart-docker.md rename to docs/source/tutorial/installation/quickstart-docker.md diff --git a/docs/source/quickstart.md b/docs/source/tutorial/installation/quickstart.md similarity index 100% rename from docs/source/quickstart.md rename to docs/source/tutorial/installation/quickstart.md From 7c8800c724784cba812e1873de565be4c299a224 Mon Sep 17 00:00:00 2001 From: alwasega Date: Mon, 23 Jan 2023 16:01:13 +0300 Subject: [PATCH 2/5] added myst references in files --- docs/source/getting-started/authenticators-users-basics.md | 2 ++ docs/source/getting-started/security-basics.md | 1 + docs/source/tutorial/installation/installation-basics.md | 2 +- docs/source/tutorial/installation/quickstart.md | 2 +- 4 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/source/getting-started/authenticators-users-basics.md b/docs/source/getting-started/authenticators-users-basics.md index 77cdffd0..a1b63a68 100644 --- a/docs/source/getting-started/authenticators-users-basics.md +++ b/docs/source/getting-started/authenticators-users-basics.md @@ -1,5 +1,7 @@ # Authentication and User Basics +(authenticators-users-basics)= + The default Authenticator uses [PAM][] (Pluggable Authentication Module) to authenticate system users with their username and password. With the default Authenticator, any user with an account and password on the system will be allowed to login. diff --git a/docs/source/getting-started/security-basics.md b/docs/source/getting-started/security-basics.md index 7385fca7..c4850806 100644 --- a/docs/source/getting-started/security-basics.md +++ b/docs/source/getting-started/security-basics.md @@ -1,4 +1,5 @@ # Security settings +(security-basics)= :::{important} You should not run JupyterHub without SSL encryption on a public network. diff --git a/docs/source/tutorial/installation/installation-basics.md b/docs/source/tutorial/installation/installation-basics.md index d9915893..f4bf2810 100644 --- a/docs/source/tutorial/installation/installation-basics.md +++ b/docs/source/tutorial/installation/installation-basics.md @@ -6,7 +6,7 @@ JupyterHub is supported on Linux/Unix based systems. To use JupyterHub, you need a Unix server (typically Linux) running somewhere that is accessible to your team on the network. The JupyterHub server can be on an internal network at your organization, or it can run on the public internet (in which case, take care -with the Hub's [security](./getting-started/security-basics)). +with the Hub's [security](security-basics). JupyterHub officially **does not** support Windows. You may be able to use JupyterHub on Windows if you use a Spawner and Authenticator that work on diff --git a/docs/source/tutorial/installation/quickstart.md b/docs/source/tutorial/installation/quickstart.md index 45c59287..1ff33624 100644 --- a/docs/source/tutorial/installation/quickstart.md +++ b/docs/source/tutorial/installation/quickstart.md @@ -27,7 +27,7 @@ Before installing JupyterHub, you will need: if your system package manager only has an old version of Node.js (e.g. 10 or older). - A [pluggable authentication module (PAM)](https://en.wikipedia.org/wiki/Pluggable_authentication_module) - to use the [default Authenticator](./getting-started/authenticators-users-basics.md). + to use the [default Authenticator](authenticators-users-basics). PAM is often available by default on most distributions, if this is not the case it can be installed by using the operating system's package manager. - TLS certificate and key for HTTPS communication From 61ad3812cef5bbf1a80369c115fb960e8e48c486 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 23 Jan 2023 12:59:55 +0000 Subject: [PATCH 3/5] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/source/getting-started/security-basics.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/source/getting-started/security-basics.md b/docs/source/getting-started/security-basics.md index c4850806..692829bc 100644 --- a/docs/source/getting-started/security-basics.md +++ b/docs/source/getting-started/security-basics.md @@ -1,4 +1,5 @@ # Security settings + (security-basics)= :::{important} From f88695084b329a55684e4f70ae9515dec7fde912 Mon Sep 17 00:00:00 2001 From: alwasega Date: Mon, 23 Jan 2023 16:24:49 +0300 Subject: [PATCH 4/5] fixed more than one myst target found error --- docs/source/getting-started/authenticators-users-basics.md | 2 +- docs/source/tutorial/installation/quickstart.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/getting-started/authenticators-users-basics.md b/docs/source/getting-started/authenticators-users-basics.md index a1b63a68..ee270fd4 100644 --- a/docs/source/getting-started/authenticators-users-basics.md +++ b/docs/source/getting-started/authenticators-users-basics.md @@ -1,6 +1,6 @@ # Authentication and User Basics -(authenticators-users-basics)= +(authenticators)= The default Authenticator uses [PAM][] (Pluggable Authentication Module) to authenticate system users with their username and password. With the default Authenticator, any user diff --git a/docs/source/tutorial/installation/quickstart.md b/docs/source/tutorial/installation/quickstart.md index 1ff33624..13a8e916 100644 --- a/docs/source/tutorial/installation/quickstart.md +++ b/docs/source/tutorial/installation/quickstart.md @@ -27,7 +27,7 @@ Before installing JupyterHub, you will need: if your system package manager only has an old version of Node.js (e.g. 10 or older). - A [pluggable authentication module (PAM)](https://en.wikipedia.org/wiki/Pluggable_authentication_module) - to use the [default Authenticator](authenticators-users-basics). + to use the [default Authenticator](authenticators). PAM is often available by default on most distributions, if this is not the case it can be installed by using the operating system's package manager. - TLS certificate and key for HTTPS communication From dd95201b900bd8a1ea1a3a5788b2a5524aa370a1 Mon Sep 17 00:00:00 2001 From: alwasega Date: Mon, 23 Jan 2023 18:19:49 +0300 Subject: [PATCH 5/5] corrected MyST anchors location and minor error --- docs/source/getting-started/authenticators-users-basics.md | 4 ++-- docs/source/getting-started/security-basics.md | 4 ++-- docs/source/tutorial/installation/installation-basics.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/source/getting-started/authenticators-users-basics.md b/docs/source/getting-started/authenticators-users-basics.md index ee270fd4..0b03cc4d 100644 --- a/docs/source/getting-started/authenticators-users-basics.md +++ b/docs/source/getting-started/authenticators-users-basics.md @@ -1,7 +1,7 @@ -# Authentication and User Basics - (authenticators)= +# Authentication and User Basics + The default Authenticator uses [PAM][] (Pluggable Authentication Module) to authenticate system users with their username and password. With the default Authenticator, any user with an account and password on the system will be allowed to login. diff --git a/docs/source/getting-started/security-basics.md b/docs/source/getting-started/security-basics.md index 692829bc..fb7f3e1f 100644 --- a/docs/source/getting-started/security-basics.md +++ b/docs/source/getting-started/security-basics.md @@ -1,7 +1,7 @@ -# Security settings - (security-basics)= +# Security settings + :::{important} You should not run JupyterHub without SSL encryption on a public network. ::: diff --git a/docs/source/tutorial/installation/installation-basics.md b/docs/source/tutorial/installation/installation-basics.md index f4bf2810..880cb09f 100644 --- a/docs/source/tutorial/installation/installation-basics.md +++ b/docs/source/tutorial/installation/installation-basics.md @@ -6,7 +6,7 @@ JupyterHub is supported on Linux/Unix based systems. To use JupyterHub, you need a Unix server (typically Linux) running somewhere that is accessible to your team on the network. The JupyterHub server can be on an internal network at your organization, or it can run on the public internet (in which case, take care -with the Hub's [security](security-basics). +with the Hub's [security](security-basics)). JupyterHub officially **does not** support Windows. You may be able to use JupyterHub on Windows if you use a Spawner and Authenticator that work on