|
1 | | -`BinderHub`_ |
2 | | -============ |
| 1 | +[BinderHub](https://github.com/jupyterhub/binderhub) |
| 2 | +==================================================== |
3 | 3 |
|
4 | | -.. image:: https://img.shields.io/travis/com/jupyterhub/binderhub/master?logo=travis |
5 | | - :target: https://travis-ci.com/jupyterhub/binderhub |
6 | | - :alt: travis status |
| 4 | +[](https://travis-ci.com/jupyterhub/binderhub) |
7 | 5 |
|
8 | | -.. image:: https://img.shields.io/readthedocs/binderhub?logo=read-the-docs |
9 | | - :target: https://binderhub.readthedocs.io/en/latest/ |
10 | | - :alt: Documentation Status |
| 6 | +[](https://binderhub.readthedocs.io/en/latest/) |
11 | 7 |
|
12 | | -.. image:: https://img.shields.io/badge/dynamic/json.svg?label=latest&url=https://jupyterhub.github.io/helm-chart/info.json&query=$.binderhub.latest&colorB=orange |
13 | | - :target: https://jupyterhub.github.io/helm-chart/ |
14 | | - :alt: Latest chart development release |
| 8 | +[](https://jupyterhub.github.io/helm-chart/) |
15 | 9 |
|
16 | | -.. image:: https://img.shields.io/badge/issue_tracking-github-blue.svg |
17 | | - :target: https://github.com/jupyterhub/binderhub/issues |
18 | | - :alt: GitHub |
| 10 | +[](https://github.com/jupyterhub/binderhub/issues) |
19 | 11 |
|
20 | | -.. image:: https://img.shields.io/badge/help_forum-discourse-blue.svg |
21 | | - :target: https://discourse.jupyter.org/c/binder/binderhub |
22 | | - :alt: Discourse |
| 12 | +[](https://discourse.jupyter.org/c/binder/binderhub) |
23 | 13 |
|
24 | | -.. image:: https://img.shields.io/badge/social_chat-gitter-blue.svg |
25 | | - :target: https://gitter.im/jupyterhub/binder |
26 | | - :alt: Gitter |
| 14 | +[](https://gitter.im/jupyterhub/binder) |
27 | 15 |
|
28 | | -.. image:: https://img.shields.io/badge/I_want_to_contribute!-grey?logo=jupyter |
29 | | - :target: https://github.com/jupyterhub/binderhub/blob/master/CONTRIBUTING.md |
30 | | - :alt: Contribute |
| 16 | +[](https://github.com/jupyterhub/binderhub/blob/master/CONTRIBUTING.md) |
31 | 17 |
|
32 | 18 | What is BinderHub? |
33 | 19 | ------------------ |
34 | 20 |
|
35 | | -**BinderHub** allows you to ``BUILD`` and ``REGISTER`` a Docker image from a |
36 | | -Git repository, then ``CONNECT`` with JupyterHub, allowing you to create a |
37 | | -public IP address that allows users to interact with the code and environment |
38 | | -within a live JupyterHub instance. You can select a specific branch name, |
39 | | -commit, or tag to serve. |
| 21 | +**BinderHub** allows you to `BUILD` and `REGISTER` a Docker image from a |
| 22 | +Git repository, then `CONNECT` with JupyterHub, allowing you to create a |
| 23 | +public IP address that allows users to interact with the code and |
| 24 | +environment within a live JupyterHub instance. You can select a specific |
| 25 | +branch name, commit, or tag to serve. |
40 | 26 |
|
41 | 27 | BinderHub ties together: |
42 | 28 |
|
43 | | -- `JupyterHub <https://github.com/jupyterhub/jupyterhub>`_ to provide |
44 | | - a scalable system for authenticating users and spawning single user |
45 | | - Jupyter Notebook servers, and |
46 | | - |
47 | | -- `Repo2Docker <https://github.com/jupyter/repo2docker>`_ which generates |
48 | | - a Docker image using a Git repository hosted online. |
49 | | - |
50 | | -BinderHub is built with Python, kubernetes, tornado, npm, webpack, and sphinx. |
| 29 | +- [JupyterHub](https://github.com/jupyterhub/jupyterhub) to provide a |
| 30 | + scalable system for authenticating users and spawning single user |
| 31 | + Jupyter Notebook servers, and |
| 32 | +- [Repo2Docker](https://github.com/jupyter/repo2docker) which |
| 33 | + generates a Docker image using a Git repository hosted online. |
51 | 34 |
|
| 35 | +BinderHub is built with Python, kubernetes, tornado, npm, webpack, and |
| 36 | +sphinx. |
52 | 37 |
|
53 | 38 | Documentation |
54 | 39 | ------------- |
55 | 40 |
|
56 | | -For more information about the architecture, use, and setup of BinderHub, see |
57 | | -`the BinderHub documentation <https://binderhub.readthedocs.io>`_. |
58 | | - |
| 41 | +For more information about the architecture, use, and setup of |
| 42 | +BinderHub, see [the BinderHub |
| 43 | +documentation](https://binderhub.readthedocs.io). |
59 | 44 |
|
60 | 45 | Contributing |
61 | 46 | ------------ |
62 | 47 |
|
63 | 48 | To contribute to the BinderHub project you can work on: |
64 | 49 |
|
65 | | -* `answering questions others have <https://discourse.jupyter.org/>`_, |
66 | | -* writing documentation, |
67 | | -* designing the user interface, or |
68 | | -* writing code. |
69 | | - |
70 | | -To see how to build the documentation, edit the user interface or modify the |
71 | | -code see `the contribution guide <https://github.com/jupyterhub/binderhub/blob/master/CONTRIBUTING.md>`_. |
| 50 | +- [answering questions others have](https://discourse.jupyter.org/), |
| 51 | +- writing documentation, |
| 52 | +- designing the user interface, or |
| 53 | +- writing code. |
72 | 54 |
|
| 55 | +To see how to build the documentation, edit the user interface or modify |
| 56 | +the code see [the contribution |
| 57 | +guide](https://github.com/jupyterhub/binderhub/blob/master/CONTRIBUTING.md). |
73 | 58 |
|
74 | 59 | Installation |
75 | 60 | ------------ |
76 | 61 |
|
77 | | -**BinderHub** is based on Python 3, it's currently only hosted on GitHub |
78 | | -(pip release soon). However, it can be installed using ``pip``:: |
| 62 | +**BinderHub** is based on Python 3, it\'s currently only hosted on |
| 63 | +GitHub (pip release soon). However, it can be installed using `pip`: |
79 | 64 |
|
80 | 65 | pip install git+https://github.com/jupyterhub/binderhub |
81 | 66 |
|
82 | | -See `the BinderHub documentation <https://binderhub.readthedocs.io>`_ for |
| 67 | +See [the BinderHub documentation](https://binderhub.readthedocs.io) for |
83 | 68 | a detailed guide on setting up your own BinderHub server. |
84 | 69 |
|
85 | | - |
86 | 70 | Why BinderHub? |
87 | 71 | -------------- |
88 | 72 |
|
89 | | -Collections of Jupyter notebooks are becoming more common in scientific research |
90 | | -and data science. The ability to serve these collections on demand enhances the |
91 | | -usefulness of these notebooks. |
92 | | - |
| 73 | +Collections of Jupyter notebooks are becoming more common in scientific |
| 74 | +research and data science. The ability to serve these collections on |
| 75 | +demand enhances the usefulness of these notebooks. |
93 | 76 |
|
94 | 77 | Who is BinderHub for? |
95 | 78 | --------------------- |
96 | | -* **Users** who want to easily interact with computational environments that |
97 | | - others have created. |
98 | | -* **Authors** who want to create links that allow users to immediately interact with a |
99 | | - computational enviroment that you specify. |
100 | | -* **Deployers** who want to create their own BinderHub to run on whatever |
101 | | - hardware they choose. |
102 | 79 |
|
| 80 | +- **Users** who want to easily interact with computational |
| 81 | + environments that others have created. |
| 82 | +- **Authors** who want to create links that allow users to immediately |
| 83 | + interact with a computational enviroment that you specify. |
| 84 | +- **Deployers** who want to create their own BinderHub to run on |
| 85 | + whatever hardware they choose. |
103 | 86 |
|
104 | 87 | License |
105 | 88 | ------- |
106 | 89 |
|
107 | | -See ``LICENSE`` file in this repository. |
108 | | - |
109 | | - |
110 | | -.. _BinderHub: https://github.com/jupyterhub/binderhub |
| 90 | +See `LICENSE` file in this repository. |
0 commit comments