Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Installation documentation improvement about installing in jupyterhub and/or jupyter server environment #357

Open
dirkdaems opened this issue Sep 2, 2024 · 1 comment

Comments

@dirkdaems
Copy link

While reading the documentation, it is not clear to me whether this extension needs to be installed on the Jupyterhub only. I can imagine that the extension also needs to be installed in the JupyterLab Docker container that is being spawned (using k8s, Docker Swarm, ...) as the repository needs to become available in that environment?
Can this be clarified?

@dirkdaems dirkdaems added the bug label Sep 2, 2024
@consideRatio
Copy link
Member

consideRatio commented Sep 2, 2024

I've not read the docs myself recently, but if you've read it and can't say clearly where it needs to be installed - i think its worth clarifying it in the docs. I've "documentation" and "help wanted" labels for this issue.

The python environment running JupyterHub itself doesn't need nbgitpuller installed. Only the Python environment that starts a jupyter server (jupyter_server or notebook) needs to have it installed, because nbgitpuller its a jupyter server extension. It shouldn't matter if the jupyter server is started via jupyterhub or not.

@consideRatio consideRatio changed the title Installation documentation improvement Installation documentation improvement about installing in jupyterhub and/or jupyter server environment Sep 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants