Commit Graph

443 Commits

Author SHA1 Message Date
Min RK
2f99104f57 a couple fixups after autoformatting 2019-02-19 17:04:37 +01:00
Min RK
5e60582ef3 run autoformat
apologies to anyone finding this commit via git blame or log

run the autoformatting by

    pre-commit run --all-files
2019-02-19 17:00:10 +01:00
Richard Darst
a6d217d113 pam_normalize_username: add docs 2019-02-07 01:35:18 +02:00
Dylan Nelson
2ee355d6a4 Update docs: deployments
Add IllustrisTNG public data release deployment.

Also add link for MIT, and delete jcloud.io (seems to no longer exist).
2018-12-30 15:04:21 +01:00
Clemens Tolboom
4b36dce29f Fix markdown link into rst 2018-12-03 19:05:50 +01:00
Min RK
ea44ab0c85 Merge pull request #2312 from choldgraf/roadmap
[MRG] moving the roadmap to this repo
2018-11-15 19:55:35 +01:00
Min RK
c633d87f1e Merge pull request #2296 from pelson/logo_in_page_template
Add a logo block, and update the docs regarding base.html.
2018-11-15 12:44:15 +01:00
Chris Holdgraf
891a352f42 updating circle for docs and adding a roadmap 2018-11-14 21:20:26 -08:00
DataVictorEngineer
7f12418e4c Apache reverse proxy customization for jupyterhub
This is the modification to run the Jupyterhub using the custom url: http://127.0.0.1:8000/jhub/.
2018-11-11 22:45:30 +02:00
Phil Elson
87ce499840 Add a logo block, and update the docs regarding base.html. 2018-11-09 06:36:17 +00:00
Matthias Bussonnier
0670423a3d Cleanup the sudo/selinux section 2018-10-18 14:03:00 -07:00
Adrian Wilke
ee63002f21 Added Paderborn University 2018-10-17 21:28:38 +02:00
Min RK
2d94b2999f Merge pull request #2055 from LLNL/end-to-end-ssl
End-to-end SSL
2018-10-17 13:27:03 +02:00
Min RK
bc3ace60dc Merge branch 'master' into end-to-end-ssl 2018-10-12 16:17:26 +02:00
Min RK
ce2310b1ae update proxy docs to mention entrypoints 2018-10-12 11:11:13 +02:00
Matthias Bussonnier
2e872069fb Use $() for command substitution instead of backticks/quotes.
One of the example was using quotes instead of backticks.
Backticks are the "older" way of doing things, which has a number of
disadvantes:

    http://mywiki.wooledge.org/BashFAQ/082

Here I'm more worried about readability as depending on font and "smart"
editor helping on the web, many people may confuse ` with ', it could
end up modifying formatting on makrdown powered website... etc...
2018-10-04 13:44:16 -07:00
Min RK
f29354e0f4 Merge branch 'master' into end-to-end-ssl 2018-10-02 11:15:53 +02:00
Nils Werner
a08a839385 Replace python with sys.executable in most service examples 2018-10-02 09:42:54 +02:00
Min RK
acdd9bb674 Merge pull request #2203 from minrk/entrypoints
allow spawners and authenticators to register via entry points
2018-10-01 17:22:11 +02:00
Chris Holdgraf
372af86250 rst code syntax in docs 2018-09-29 09:09:31 -07:00
Thomas Mendoza
a13f4197d4 Move proxy cert creation into .init_internal_ssl 2018-09-28 16:33:18 -07:00
Chris Holdgraf
c48988afcb pip command update 2018-09-28 12:00:28 -07:00
Min RK
c02ab23b3d allow spawners and authenticators to register via entrypoints
jupyterhub.authenticators for authenticators, jupyterhub.spawners for spawners

This has the effect that authenticators and spawners can be selected by name instead of full import string (e.g. 'github' or 'dummy' or 'kubernetes')
and, perhaps more importantly, the autogenerated configuration file will include a section for each installed and registered class.
2018-09-28 10:08:10 +02:00
Kyla Harper
a78655c5a7 Add DummyAuthenticator documentation 2018-09-27 11:42:06 -05:00
Min RK
fa79e233b7 Merge pull request #2196 from choldgraf/copybutton
add a copy button to code cells
2018-09-27 14:13:56 +02:00
yuvipanda
6ca5b3aa70 Fixup upgrade toctree in index.rst 2018-09-27 00:16:24 -07:00
yuvipanda
e6a5dd1273 Fixes per @betatim & @choldgraf 2018-09-27 00:13:07 -07:00
yuvipanda
358b830747 Expand & consolidate upgrade documentation
- Expands the previous documentation on upgrading JupyterHub
  to include more information.
- Remove specific documentation on 0.7 -> 0.8 upgrade, since
  this seems to be a straight copy of the markdown version of
  upgrading docs. The important thing about the 0.7 -> 0.8 upgrade
  (requiring versions of JupyterHub to match) is now in the
  main document.
- Move from markdown to rst
2018-09-26 23:53:51 -07:00
yuvipanda
a91e94dd16 Re-order 'upgrading' section in main documentation page
Info on upgrading is important & relevant. This consolidates
the index to be a bit better. Next step is to consolidate the
documentation into one page.

Removes the 'tutorials' index page as well, since that only
had a reference to z2jh (which is now referenced from the
'distribution' section). The distribution section has
better visibility too
2018-09-26 23:53:19 -07:00
Chris Holdgraf
3dc0a8388b copy button 2018-09-26 18:34:51 -04:00
yuvipanda
7c273296c2 Use python3 -m pip explicitly in docs
- Add a documentation convention listing this too.

Fixes #2191
2018-09-26 12:14:43 -07:00
yuvipanda
b9331dbd57 Reformat index.rst to get linkable sections
Currently, the sections in index.rst are using ** for bold,
rather than true section headers. This prevents them from being
linkable. Since we'd like to link to the 'contributing' section
from CONTRIBUTING.md, we change this by moving everything to
section headers. We also move to the toctree directive, since
it keeps the bullets aligned properly (they were hanging if
we used simple * markers)

This also replaces CONTRIBUTING.md content with a link to
the docs.
2018-09-25 18:35:38 -07:00
yuvipanda
c928d10316 Expand contributor documentation
- Move from CONTRIBUTING.md to a subdirectory in docs, so
  we can expand and add more documentation.
- Move from markdown to reStructuredTest
- Add a direct blurb in the JupyterHub docs index page on
  how contribution.
- More prominent link to the Code of Conduct
- Add section on getting in touch with the JupyterHub community
2018-09-25 18:19:09 -07:00
Min RK
33c6e68b5e update changelog for 0.9.4 2018-09-24 14:01:23 +02:00
Min RK
c87fcd9b71 Merge pull request #2155 from minrk/cleanup-client-fix
fix oauth client cleanup
2018-09-21 10:10:34 +02:00
yuvipanda
07b590e2c3 Link additional authenticators to wiki
The current list in the docs is out of date. The list
in the wiki is more up-to-date, and easier for folks
to change over time. In the long run, we should decide
where lists like this belong.
2018-09-20 22:49:00 -07:00
Min RK
4cd4fd1dff changelog for 0.9.4 2018-09-19 12:48:21 +02:00
Carol Willing
7ff49705bc fix typo 2018-09-12 08:41:05 -07:00
Carol Willing
6dc43dd70b add link to community guide reference 2018-09-12 08:39:07 -07:00
Min RK
0239ff8646 changelog for 0.9.3
Mainly small fixes, but the token page could be completely broken

This release will include the spawner.handler addition,
but not the oauthlib change currently in master
2018-09-11 11:06:31 +02:00
Carol Willing
30d9e09390 fix link 2018-09-05 11:27:19 -07:00
Thomas Mendoza
ca33ccd66d Add longer internal_ssl documentation to main docs 2018-09-04 15:51:26 -07:00
Matthias Bussonnier
077d8dec9a Fix some typos using codespell.
And checking each manually. It's funny because one of the words in the
sphinx custom dictionary was wrong :-)
2018-08-29 21:24:28 -07:00
Min RK
85aac0fa2d prepare to release 0.9.2 2018-08-10 13:56:58 +02:00
Kenan Erdogan
71cb628563 fix links in services doc 2018-08-06 11:11:14 +02: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
Min RK
22863f765f 0.9.1 2018-07-04 11:55:42 +02:00
Min RK
55f58b3ba7 review, note proxy prefix fix 2018-07-03 15:12:30 +02:00
Min RK
7dfdc23b4e Prepare changelog for 0.9.1 2018-07-03 11:44:37 +02:00
Alex Marandon
678afd3783 Fix a couple of typos 2018-07-03 11:16:55 +02:00