search

jupyterhub / the-littlest-jupyterhub

Simple JupyterHub distribution for 1-100 users on a single server
https://tljh.jupyter.org
BSD 3-Clause "New" or "Revised" License
1.03k stars 339 forks source link

Documentation on docker support is confusing #684

Open rigelifland opened 3 years ago

rigelifland commented 3 years ago

More or less a repost of: https://discourse.jupyter.org/t/jupyterhub-tljh-has-confusing-documentation-on-docker-support/8949

The installation documentation contains the following note at the top of the page:

Running TLJH inside a docker container is not supported, since we depend on systemd. If you want to run TLJH locally for development, see Setting up Development Environment.

The development instructions detail how to setup TLJH with docker, which seems confusingly contradictory to the first statement.

Proposed change

Update the note to say something along these lines:

Running TLJH inside a docker container is possible, but not officially supported. If you want to run TLJH locally for development, see Setting up Development Environment.

welcome[bot] commented 3 years ago

Thank you for opening your first issue in this project! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out Jupyter's Code of Conduct. Also, please try to follow the issue template as it helps other other community members to contribute more effectively. welcome You can meet the other Jovyans by joining our Discourse forum. There is also an intro thread there where you can stop by and say Hi! :wave:
Welcome to the Jupyter community! :tada:

rigelifland commented 3 years ago

In retrospect, the note seems to make two separate statements: One about docker support, and another about setting up a dev environment. Perhaps they should be separate notes? Or is the note really only about how to set up a dev environment, in which case perhaps a better note would be:

If you want to run TLJH locally for development, see Setting up Development Environment. While the development environment uses Docker, it is not officially supported and bugs relating to Docker should not be reported.