diff --git a/docs/source/contributing/setup.md b/docs/source/contributing/setup.md index 52b99bea..ddadd583 100644 --- a/docs/source/contributing/setup.md +++ b/docs/source/contributing/setup.md @@ -2,12 +2,31 @@ # Setting up a development install +JupyterHub's continuous integration runs on [Ubuntu LTS](https://ubuntu.com/). + +While JupyterHub is only tested on one [Linux distribution](https://en.wikipedia.org/wiki/Linux_distribution), +it should be fairly insensitive to variations between common [POXIS](https://en.wikipedia.org/wiki/POSIX) implementation, +though we don't have the bandwidth to verify this automatically and continuously. + +Feel free to try it on your platform, and be sure to {ref}`let us know ` about any issues you encounter. + ## System requirements -JupyterHub can only run on macOS or Linux operating systems. If you are -using Windows, we recommend using [VirtualBox](https://www.virtualbox.org) -or a similar system to run [Ubuntu Linux](https://ubuntu.com) for -development. +Your system **must** be able to run + +- Python +- NodeJS +- Git + +Our small team knows JupyterHub to work perfectly on macOS or Linux operating systems. + +```{admonition} What about Windows? +Some users have reported that JupyterHub runs successfully on [Windows Subsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/). We have no plans to support Windows outside of the WSL. +``` + +```{admonition} What about virtualization? +Using any form of virtualization (for example, [VirtualBox](https://www.virtualbox.org/), [Docker](https://www.docker.com/), [Podman](https://podman.io/), [WSL](https://learn.microsoft.com/en-us/windows/wsl/)) is a good way to get up and running quickly, though properly configuring the networking settings can be a bit tricky. +``` ### Install Python