diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..e68b151 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,8 @@ +Contributing to The Littlest JupyterHub development +--------------------------------------------------- + +This is an open source project that is developed and maintained by volunteers. +Your contribution is integral to the future of the project. Thank you! + +See the `contributing guide `_ +for information on the different ways of contributing to The Littlest JupyterHub. diff --git a/README.rst b/README.rst index 634a387..258d6c9 100644 --- a/README.rst +++ b/README.rst @@ -10,18 +10,29 @@ The Littlest JupyterHub :target: https://the-littlest-jupyterhub.readthedocs.io .. image:: https://badges.gitter.im/jupyterhub/jupyterhub.svg :target: https://gitter.im/jupyterhub/jupyterhub +.. image:: https://img.shields.io/badge/I_want_to_contribute!-grey?logo=jupyter + :target: https://the-littlest-jupyterhub.readthedocs.io/en/latest/contributing/index.html **The Littlest JupyterHub** (TLJH) distribution helps you provide Jupyter Notebooks to 1-50 users on a single server. -Administrators who do not consider themselves 'system administrators' but would -like to provide hosted Jupyter Notebooks for their students / users are the -primary audience. All users are provided with the same environment, and administrators +The primary audience are people who do not consider themselves 'system administrators' +but would like to provide hosted Jupyter Notebooks for their students or users. +All users are provided with the same environment, and administrators can easily install libraries into this environment without any specialized knowledge. +See the `latest documentation `_ +for more information on using The Littlest JupyterHub. + +For support questions please search or post to `our forum `_. + +See the `contributing guide `_ +for information on the different ways of contributing to The Littlest JupyterHub. + See `this blog post `_ for more information. + Development Status ================== @@ -34,7 +45,7 @@ Installation The Littlest JupyterHub (TLJH) can run on any server that is running at least **Ubuntu 18.04**. Earlier versions of Ubuntu are not supported. -We have a bunch of tutorials to get you started. +We have several tutorials to get you started. - Tutorials to create a new server from scratch on a cloud provider & run TLJH on it. These are **recommended** if you do not have much experience setting up diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst index 764ca02..80bb516 100644 --- a/docs/contributing/index.rst +++ b/docs/contributing/index.rst @@ -2,16 +2,21 @@ Contributing ============ -We want you to contribute to TLJH in the ways that are most useful -and exciting to you. This section contains documentation helpful -to people contributing in various ways. +✨ Thank you for thinking about contributing to the littlest JupyterHub! ✨ + +This is an open source project that is developed and maintained by volunteers. +Your contribution is integral to the future of the project. Thank you! + +This section contains documentation for people who want to contribute. + +You can find the `source code on GitHub `_ .. toctree:: :titlesonly: docs - code-review dev-setup tests plugins + code-review packages