search

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
210 stars 86 forks source link

Revise index.rst to indicate broader scope than just education #236

Closed rabernat closed 2 years ago

rabernat commented 2 years ago

I love nbgitpuller and use it frequently.

When reading the documentation, constant reference is made to "students" and "instructors". However, nbgitpuller has broad use outside of just teaching, e.g. for separating the environment of a binder from its content.

I would propose to revise the descriptions in index.rst to indicate this broader scope, making sure to mention classroom usage as one of the main applications.

If the maintainers agree, I would be happy to contribute a PR.

welcome[bot] commented 2 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:

yuvipanda commented 2 years ago

@rabernat i'd love it!