Document that users shouldn't actively be running git commands along with nbgitpuller

jupyterhub / nbgitpuller

Jupyter server extension to sync a git repository one-way to a local path

https://nbgitpuller.readthedocs.io

BSD 3-Clause "New" or "Revised" License

212 stars 86 forks source link

Document that users shouldn't actively be running git commands along with nbgitpuller #314

Open yuvipanda opened 1 year ago

yuvipanda commented 1 year ago

nbgitpuller is meant as a distribution mechanism. If users are also actively running git commands on the nbgitpuller checkout, switching branches, etc, nbgitpuller is going to get into inconsistent states it can't get out of.

We should document this prominently somewhere!