Merge pull request #489 from betatim/link-contrib-guide

[MRG] Link contributing guide
This commit is contained in:
Georgiana Elena
2020-01-27 12:09:53 +02:00
committed by GitHub
3 changed files with 32 additions and 8 deletions

8
CONTRIBUTING.rst Normal file
View File

@@ -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 <https://the-littlest-jupyterhub.readthedocs.io/en/latest/contributing/index.html>`_
for information on the different ways of contributing to The Littlest JupyterHub.

View File

@@ -10,18 +10,29 @@ The Littlest JupyterHub
:target: https://the-littlest-jupyterhub.readthedocs.io :target: https://the-littlest-jupyterhub.readthedocs.io
.. image:: https://badges.gitter.im/jupyterhub/jupyterhub.svg .. image:: https://badges.gitter.im/jupyterhub/jupyterhub.svg
:target: https://gitter.im/jupyterhub/jupyterhub :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 **The Littlest JupyterHub** (TLJH) distribution helps you provide Jupyter Notebooks
to 1-50 users on a single server. to 1-50 users on a single server.
Administrators who do not consider themselves 'system administrators' but would The primary audience are people who do not consider themselves 'system administrators'
like to provide hosted Jupyter Notebooks for their students / users are the but would like to provide hosted Jupyter Notebooks for their students or users.
primary audience. All users are provided with the same environment, and administrators All users are provided with the same environment, and administrators
can easily install libraries into this environment without any specialized knowledge. can easily install libraries into this environment without any specialized knowledge.
See the `latest documentation <https://the-littlest-jupyterhub.readthedocs.io>`_
for more information on using The Littlest JupyterHub.
For support questions please search or post to `our forum <https://discourse.jupyter.org/c/jupyterhub/>`_.
See the `contributing guide <https://the-littlest-jupyterhub.readthedocs.io/en/latest/contributing/index.html>`_
for information on the different ways of contributing to The Littlest JupyterHub.
See `this blog post <http://words.yuvi.in/post/the-littlest-jupyterhub/>`_ for See `this blog post <http://words.yuvi.in/post/the-littlest-jupyterhub/>`_ for
more information. more information.
Development Status Development Status
================== ==================
@@ -34,7 +45,7 @@ Installation
The Littlest JupyterHub (TLJH) can run on any server that is running at least The Littlest JupyterHub (TLJH) can run on any server that is running at least
**Ubuntu 18.04**. Earlier versions of Ubuntu are not supported. **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 - 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 on it. These are **recommended** if you do not have much experience setting up

View File

@@ -2,16 +2,21 @@
Contributing Contributing
============ ============
We want you to contribute to TLJH in the ways that are most useful ✨ Thank you for thinking about contributing to the littlest JupyterHub! ✨
and exciting to you. This section contains documentation helpful
to people contributing in various ways. 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 <https://github.com/jupyterhub/the-littlest-jupyterhub/tree/master/tljh>`_
.. toctree:: .. toctree::
:titlesonly: :titlesonly:
docs docs
code-review
dev-setup dev-setup
tests tests
plugins plugins
code-review
packages packages