Commit Graph

121 Commits

Author SHA1 Message Date
Piyush Jain
93c488f840 Corrected Getting Started Link
Current getting started link in README is broken.
2023-02-24 16:15:42 -08:00
Pris Nasrat
6de12313e1 Remove PDF links from README.md
Fixes #4320
2023-02-17 08:25:46 -05:00
Erik Sundell
124ae60133 Remove no longer relevant notice in readme 2023-01-30 07:48:18 +01:00
Min RK
de5fb1e7ce Merge branch 'main' into copyediting 2022-11-24 09:40:21 +01:00
Félix-Antoine Fortin
13e99b904b Fix typo in [rest api] link 2022-04-08 09:56:18 -04:00
Min RK
ffa5a20e2f localhost URL is not https 2022-01-03 15:41:54 +01:00
Min RK
468aa5e93c render openapi spec client-side
- move spec to _static/rest-api.yml, since the original yaml must be served
- copy javascript rendering code from FastAPI (uses swagger-ui)
- remove link to pet store, since there isn't a big enough difference to duplicate it
- remove bootprint rendering with node
2021-10-29 13:13:41 +02:00
Simon Li
cfd2ca9065 Update README
- circle CI no longer used
- ubuntu/debian nodejs may be too old (12.0+ required)
- remove mention of mailing list
- Python 3.6 required
- Emphasise JupyterLab over notebook
2021-09-11 13:39:41 +01:00
Hassan Raza Bukhari
56c10e8799 Update README.md 2021-08-13 01:16:05 +05:00
Hassan Raza Bukhari
f6178ae51d Improved Grammar for the Documentation
Slight improvements in grammar were done in the ReadMe file.
2021-08-12 21:43:42 +05:00
Erik Sundell
017579afd1 docs: fix conda-forge badge link in README 2021-07-16 14:16:39 +02:00
passer
bab5532b98 Fix contributor documentation's link 2021-06-19 12:37:08 +08:00
Sarah Gibson
c4e711178a Update README.md 2021-06-11 11:57:01 +01:00
Sarah Gibson
ba660cdeab Add research study participation notice to readme 2021-06-11 11:54:43 +01:00
Min RK
63a61bcc2f prepare to rename default branch to main
- update references to default branch name in docs, workflows
- use HEAD in github urls, which always works regardless of default branch name
- fix petstore URLs since the old petstore links seem to have stopped working
2021-05-11 10:40:04 +02:00
Min RK
9331dd13da run pre-commit (prettier) 2021-02-12 15:25:58 +01:00
Erik Sundell
8e603e5212 docs: update README.md badge for github actions 2021-01-08 01:16:29 +01:00
Erik Sundell
5fa540bea1 Update travis-ci badge in README.md 2020-10-28 22:59:44 +01:00
romainx
0e59ab003a Readme updated according to review 2020-05-11 14:54:32 +02:00
romainx
8859bf8842 #1018 PAM added in prerequisites 2020-05-08 06:06:42 +02:00
Erik Sundell
3c12a99415 Update README's badges
Some notes:
- Added a conda-forge and DockerHub badge
- Added logo's and made us conform with the team-compass badges section
as can be found here:
  https://jupyterhub-team-compass.readthedocs.io/en/latest/building-blocks/readme-badges.html
- Concluded that our CircleCI badge is good because it let's us overview
the repo's build systems, but that it is bad because it is only is about
documentation preview in PRs which isn't useful in a README's header in
a way.
- Noted there was a CircleCI token in the badge, that I believe is meant
to be used with private repo access rather than public repo access. I'm
not sure we need that but I made it a markdown/html comment for now.
- Decided to not manually add a line break between badges. I figured it
could make sense to break manually before the social badges instead of
automatically letting it wrap at some point, but we don't really know
the size of the window viewing so it felt like a bad idea to hardcode
that.
2019-12-28 14:56:56 +01:00
Matt Shannon
077727595c Add Jupyter community link 2019-08-21 13:05:04 -07:00
Eric Dill
e243812745 Some suggestions from reading through the docs
Thanks to @willingc, @minrk and @manics for the review so far.
This commit is the PR so far rebased onto master and squashed.
2019-07-17 11:51:20 -04:00
Jim Crist
fad6900779 Update a few links [ci skip]
These projects recently moved under the JupyterHub organization,
updated the links accordingly.
2019-07-16 12:06:19 -05:00
Jim Crist
76f134c393 Add a few links for JupyterHub on Hadoop [skip ci]
- JupyterHub on Hadoop Guide: https://github.com/jcrist/jupyterhub-on-hadoop
- YarnSpawner: https://github.com/jcrist/yarnspawner
- KerberosAuthenticator: https://github.com/jcrist/kerberosauthenticator
2019-04-24 14:40:50 -05:00
Erik Sundell
78fe52bfb8 Remove google group badge 2019-02-02 14:59:28 +01:00
Erik Sundell
383cd6e73d Add github/discourse/gitter badges 2019-02-02 14:59:16 +01:00
Erik Sundell
25fa0f739f Remove 0.7.2 docs badge 2019-02-02 14:58:45 +01:00
Chris Holdgraf
891a352f42 updating circle for docs and adding a roadmap 2018-11-14 21:20:26 -08:00
Carol Willing
6dc43dd70b add link to community guide reference 2018-09-12 08:39:07 -07:00
Matthias Bussonnier
a1c2a50810 Switch protocols to https in docs links
Chrome will start to show insecure website for http next week
2018-07-22 18:58:22 -07:00
Kevin P. Fleming
6bd0febbe1 Correct 'conda' installation instructions
JupyterHub packages are in the 'conda-forge' channel of Anaconda packages; if the Anaconda installation doesn't already have 'conda-forge' enabled, `conda install jupyterhub` fails.

Rather than adding instructions to enable 'conda-forge' in Anaconda, this patch modifies the installation command to specify that channel.
2018-06-13 09:42:05 -04:00
Carol Willing
a7226a8231 changes per @minrk review 2018-06-07 09:10:04 -07:00
Carol Willing
3d497a7f43 clarify that conda installs npm and proxy 2018-06-06 06:56:22 -07:00
J Forde
a46287c4a6 Update README.md
We should probably use the verb spawn to refer to the spawner since the spawner is the name of a specific part of JHub
2018-04-30 13:27:25 +02:00
Tim Freund
0c9e5fd10b Update docker volumes link
The old link now returns 404.
2018-01-11 21:28:24 -05:00
Carol Willing
3c597339ba Add CHP to dev install and move to CONTRIBUTING 2018-01-03 11:52:01 +01:00
Jesse Kinkead
f5ccfc3f8a Use travis timeout; expand documentation on timeout. 2017-11-29 14:46:18 -08:00
Jesse Kinkead
af71e79371 Include instructions for increasing test timeout. 2017-11-29 13:05:01 -08:00
Min RK
bf911cf3a5 Merge pull request #1545 from ankitksharma/patch-1
Publish exposed port in docker run command
2017-11-29 18:15:46 +01:00
Seak Pek Chhan
86aebbcaea Switch to python3 -m pip install instead of calling pip directly, move cd docs closer to make commands. 2017-11-21 14:02:07 -05:00
Seak Pek Chhan
d1bed1b9cc Add doc for building docs locally. 2017-11-21 12:15:30 -05:00
Ankit Sharma
4fc06e9504 Publish exposed port in docker run command 2017-11-18 00:14:38 +05:30
Min RK
9e2663491e strike mention of IPython notebook in README
It's been long enough that we can call it Jupyter notebook, I think
2017-11-07 10:01:14 +01:00
Andrea Zonca
d3a6aa2471 Fix broken jupyterhub getting started link 2017-08-14 16:02:40 -05:00
Carol Willing
bcdcf4351d Fix link to direct to docs not source 2017-07-25 07:04:47 -07:00
Min RK
0fd1a95405 Merge pull request #1239 from willingc/remove-33
Bump Python support to 3.4 and up
2017-07-20 13:48:56 +02:00
Carol Willing
e8a3c4dac6 Fix link 2017-07-19 17:33:14 -07:00
Carol Willing
33f2026dac Add badge for 0.7.2 docs to README 2017-07-19 17:30:57 -07:00
Carol Willing
d34f6e779d Bump Python support to 3.4 and up 2017-07-19 14:57:52 -07:00