From 92d59cd12b3697ad5977720cd975e25f722cb6b2 Mon Sep 17 00:00:00 2001 From: Simon Li Date: Thu, 21 Mar 2024 20:00:42 +0000 Subject: [PATCH 1/3] docs: Consistently use minimum Python 3.8 --- README.md | 2 +- docs/source/conf.py | 1 + docs/source/contributing/setup.md | 4 ++-- docs/source/tutorial/quickstart.md | 2 +- 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e500f931..290ab2c9 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,7 @@ for administration of the Hub and its users. ### Check prerequisites - A Linux/Unix based system -- [Python](https://www.python.org/downloads/) 3.6 or greater +- [Python](https://www.python.org/downloads/) 3.8 or greater - [nodejs/npm](https://www.npmjs.com/) - If you are using **`conda`**, the nodejs and npm dependencies will be installed for diff --git a/docs/source/conf.py b/docs/source/conf.py index 213b32e6..9e952e8e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -70,6 +70,7 @@ myst_enable_extensions = [ myst_substitutions = { # date example: Dev 07, 2022 "date": datetime.date.today().strftime("%b %d, %Y").title(), + "python_min": "3.8", "version": jupyterhub.__version__, } diff --git a/docs/source/contributing/setup.md b/docs/source/contributing/setup.md index eaea5957..1edf0ca5 100644 --- a/docs/source/contributing/setup.md +++ b/docs/source/contributing/setup.md @@ -12,7 +12,7 @@ development. ### Install Python JupyterHub is written in the [Python](https://python.org) programming language and -requires you have at least version 3.8 installed locally. If you haven’t +requires you have at least version {{python_min}} installed locally. If you haven’t installed Python before, the recommended way to install it is to use [Miniforge](https://github.com/conda-forge/miniforge#download). @@ -59,7 +59,7 @@ a more detailed discussion. python -V ``` - This should return a version number greater than or equal to 3.8. + This should return a version number greater than or equal to {{python_min}}. ```bash npm -v diff --git a/docs/source/tutorial/quickstart.md b/docs/source/tutorial/quickstart.md index 13a8e916..b3700586 100644 --- a/docs/source/tutorial/quickstart.md +++ b/docs/source/tutorial/quickstart.md @@ -5,7 +5,7 @@ Before installing JupyterHub, you will need: - a Linux/Unix-based system -- [Python](https://www.python.org/downloads/) 3.6 or greater. An understanding +- [Python {{python_min}}](https://www.python.org/downloads/) or greater. An understanding of using [`pip`](https://pip.pypa.io) or [`conda`](https://docs.conda.io/projects/conda/en/latest/user-guide/getting-started.html) for installing Python packages is helpful. From acf7d7daaa0dc125dcd23a936638a401b8162a97 Mon Sep 17 00:00:00 2001 From: Simon Li Date: Thu, 21 Mar 2024 20:01:40 +0000 Subject: [PATCH 2/3] docs: use sphinx var for min node version --- docs/source/conf.py | 1 + docs/source/contributing/setup.md | 2 +- docs/source/tutorial/quickstart.md | 4 ++-- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 9e952e8e..4e357d87 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -70,6 +70,7 @@ myst_enable_extensions = [ myst_substitutions = { # date example: Dev 07, 2022 "date": datetime.date.today().strftime("%b %d, %Y").title(), + "node_min": "12", "python_min": "3.8", "version": jupyterhub.__version__, } diff --git a/docs/source/contributing/setup.md b/docs/source/contributing/setup.md index 1edf0ca5..9b6cf9f3 100644 --- a/docs/source/contributing/setup.md +++ b/docs/source/contributing/setup.md @@ -18,7 +18,7 @@ installed Python before, the recommended way to install it is to use ### Install nodejs -[NodeJS 12+](https://nodejs.org/en/) is required for building some JavaScript components. +[NodeJS {{node_min}}+](https://nodejs.org/en/) is required for building some JavaScript components. `configurable-http-proxy`, the default proxy implementation for JupyterHub, is written in Javascript. If you have not installed NodeJS before, we recommend installing it in the `miniconda` environment you set up for Python. You can do so with `conda install nodejs`. diff --git a/docs/source/tutorial/quickstart.md b/docs/source/tutorial/quickstart.md index b3700586..eca85a9e 100644 --- a/docs/source/tutorial/quickstart.md +++ b/docs/source/tutorial/quickstart.md @@ -9,7 +9,7 @@ Before installing JupyterHub, you will need: of using [`pip`](https://pip.pypa.io) or [`conda`](https://docs.conda.io/projects/conda/en/latest/user-guide/getting-started.html) for installing Python packages is helpful. -- [nodejs/npm](https://www.npmjs.com/). [Install nodejs/npm](https://docs.npmjs.com/getting-started/installing-node), +- [Node.js {{node_min}}](https://www.npmjs.com/) or greater, along with npm. [Install Node.js/npm](https://docs.npmjs.com/getting-started/installing-node), using your operating system's package manager. - If you are using **`conda`**, the nodejs and npm dependencies will be installed for @@ -24,7 +24,7 @@ Before installing JupyterHub, you will need: ``` [nodesource][] is a great resource to get more recent versions of the nodejs runtime, - if your system package manager only has an old version of Node.js (e.g. 10 or older). + if your system package manager only has an old version of Node.js. - A [pluggable authentication module (PAM)](https://en.wikipedia.org/wiki/Pluggable_authentication_module) to use the [default Authenticator](authenticators). From 352826a1ec4c75aaf8892d73082e5d0af0bcb9aa Mon Sep 17 00:00:00 2001 From: Simon Li Date: Thu, 21 Mar 2024 20:01:54 +0000 Subject: [PATCH 3/3] docs: fix unrelated rendering error --- docs/source/contributing/setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/contributing/setup.md b/docs/source/contributing/setup.md index 9b6cf9f3..92da6428 100644 --- a/docs/source/contributing/setup.md +++ b/docs/source/contributing/setup.md @@ -23,7 +23,7 @@ installed Python before, the recommended way to install it is to use If you have not installed NodeJS before, we recommend installing it in the `miniconda` environment you set up for Python. You can do so with `conda install nodejs`. -Many in the Jupyter community use \[`nvm`\]() to +Many in the Jupyter community use [`nvm`](https://github.com/nvm-sh/nvm) to managing node dependencies. ### Install git