From f2f2313df59d740e8f5ff40e34439437e0a194a3 Mon Sep 17 00:00:00 2001 From: Tim Head Date: Fri, 24 Jan 2020 08:19:35 +0100 Subject: [PATCH 1/4] Add links to documentation and contributing guide Make links to the documentation and contributing guide more prominent. --- README.rst | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 634a387..36b2e8b 100644 --- a/README.rst +++ b/README.rst @@ -14,14 +14,23 @@ The Littlest JupyterHub **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 +43,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 From eb7fdfebba2fdc81f3c2aced7c0c39c04033cbc9 Mon Sep 17 00:00:00 2001 From: Tim Head Date: Fri, 24 Jan 2020 08:25:44 +0100 Subject: [PATCH 2/4] Reword introduction in contributing docs --- docs/contributing/index.rst | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst index 764ca02..0e66b91 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 From f2c33a692843bdc22b5e9bc432deaef72b55f2f7 Mon Sep 17 00:00:00 2001 From: Tim Head Date: Fri, 24 Jan 2020 19:07:34 +0100 Subject: [PATCH 3/4] Apply rst fixes and missing links Co-Authored-By: Georgiana Elena --- README.rst | 2 +- docs/contributing/index.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 36b2e8b..2531ce2 100644 --- a/README.rst +++ b/README.rst @@ -24,7 +24,7 @@ for more information on using The Littlest JupyterHub. For support questions please search or post to `our forum `_. -See the `contributing guide `_` +See the `contributing guide `_ for information on the different ways of contributing to the littlest JupyterHub. See `this blog post `_ for diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst index 0e66b91..80bb516 100644 --- a/docs/contributing/index.rst +++ b/docs/contributing/index.rst @@ -9,7 +9,7 @@ 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 <>`_ +You can find the `source code on GitHub `_ .. toctree:: :titlesonly: From 5e37dc2de3e8fc18993ff619d1c4b96cf6e9e07c Mon Sep 17 00:00:00 2001 From: Tim Head Date: Sat, 25 Jan 2020 14:58:19 +0100 Subject: [PATCH 4/4] Add CONTRIBUTING file --- CONTRIBUTING.rst | 8 ++++++++ README.rst | 4 +++- 2 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.rst 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 2531ce2..258d6c9 100644 --- a/README.rst +++ b/README.rst @@ -10,6 +10,8 @@ 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. @@ -25,7 +27,7 @@ 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. +for information on the different ways of contributing to The Littlest JupyterHub. See `this blog post `_ for more information.