Commit Graph

1384 Commits

Author SHA1 Message Date
Min RK
5cddce343d make sure types are declared in spec linter 2024-02-07 15:32:53 +01:00
Min RK
9a75622ee5 stricter api lint
error instead of warn, otherwise CI will pass
2024-02-07 14:20:06 +01:00
Min RK
a033653918 add rest-api to top-level reference index 2024-02-07 13:17:55 +01:00
Min RK
c15116c76c only download redoc.js for html builder 2024-02-07 13:16:46 +01:00
Min RK
ffa07afd80 fix nullable items found by linter 2024-02-07 13:12:03 +01:00
Min RK
c520102008 satisfly redocly lint with operationIds
operationIds don't need to be meaningful, but they are used in links, so should be stable
2024-02-07 12:54:51 +01:00
Min RK
ded7610b88 update openapi to 3.1.0
allows uncommenting our DELETE body spec
2024-02-07 12:39:20 +01:00
Min RK
829c65d76e add link back to rest of docs from rest-api
because rest-api has no nav elements
2024-02-07 12:32:13 +01:00
Min RK
0082f5b3da generate rest API with redoc
via custom template
2024-02-07 12:30:57 +01:00
Min RK
2c93299764 Merge pull request #4699 from minrk/clarify-user-security
clarify some points where users can disable security for their own servers
2024-02-07 08:35:38 +01:00
Min RK
41fff711e7 user-initiated sharing (#4594)
Squashed merge of https://github.com/jupyterhub/jupyterhub/pull/4594

Co-authored-by: Samuel Gaist <samuel.gaist@idiap.ch>
2024-02-07 08:34:39 +01:00
Min RK
a20b29fb1c clarify some points where users can disable security for their own servers 2024-02-06 13:28:59 +01:00
pre-commit-ci[bot]
ef568e3d61 [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
2024-02-05 20:27:29 +00:00
Erik Sundell
46fbd0465e Merge pull request #4677 from minrk/expires_in_validate
Improve validation, docs for token.expires_in
2024-01-25 00:19:33 +01:00
Erik Sundell
92da2c12fd Merge pull request #4479 from minrk/jupyterhub-public-url
add JupyterHub.public_url config
2024-01-24 23:56:58 +01:00
Min RK
47e8bbaf5e regen rest-api 2024-01-23 10:48:49 +01:00
Min RK
d3d6d0a997 document 0 for no expiration
Co-authored-by: Simon Li <orpheus+devel@gmail.com>
2024-01-23 10:47:26 +01:00
Min RK
8c3596d923 Improve validation, docs for token.expires_in
- accept 0 meaning no expiration, since folks have tried to use it that way
- clear error message for invalid (e.g. negative) values
- specify example in rest api doc so it doesn't default to invalid `0`
- better error if orm token fails to be retrieved
2024-01-19 10:23:49 +01:00
Min RK
965e4a91d6 update linkcheck to ignore example.org/com 2024-01-15 12:28:30 +01:00
Min RK
1a5220d5d8 Consistent example public_url
with jupyterhub.example.org

Co-authored-by: Simon Li <orpheus+devel@gmail.com>
2024-01-15 10:04:45 +01:00
Min RK
4dd430e080 Merge branch 'main' into jupyterhub-public-url 2024-01-11 10:24:44 +01:00
Min RK
603c59a307 use $http_host in nginx proxy header
$host is the hostname, $http_host is `hostname[:port]`, which is what's needed here

$host works fine in the example because it uses the default port 80, but if it's on a different port
it will differ from the http Host header, resulting in cross-origin check errors.
2024-01-11 09:17:08 +01:00
YuviPanda
a142876a4e docs: Remove non-actionable step from developer setup
I just went through these with @jmunroe, and found the
db step a little confusing - there is no action to really be
taken here, as pretty much everyone just uses sqlite for
development (and even production). So I've just removed that
step, as python almost always ships with sqlite built into it.
2023-12-17 13:05:19 -08:00
BenGig
41c5be8fbe ETHZ added to references in documentation (#4638)
Co-authored-by: Katrin Bentel <43048197+KatrinIB@users.noreply.github.com>
2023-11-24 16:15:49 +01:00
Simon Li
79e75be9f3 authenticator reference doc: mention admin and RBAC 2023-11-17 23:31:53 +00:00
Simon Li
99d72dfccf authenticator reference doc: update authenticate return 2023-11-16 19:16:54 +00:00
Min RK
d2bff90f17 support specifying token permissions in UI
- add scopes field to token form
- add permissions column to token tables
- expand docs on specifying token scopes, including api example
2023-11-13 12:27:08 +01:00
linyucheng
d5bc3856aa doc: Add the include_stopped_server field to the /users/name interface 2023-11-08 21:47:35 +08:00
Yuvi Panda
a8e43198a9 Fix capitalization
Co-authored-by: Ayaz Salikhov <mathbunnyru@users.noreply.github.com>
2023-11-06 14:42:40 +05:30
YuviPanda
f366b785a3 Move from dockerhub to quay.io
See https://github.com/jupyterhub/team-compass/issues/688
for context.

I've also added `QUAY_USERNAME` and `QUAY_PASSWORD` to environment
secrets, but *not* `env.REGISTRY`. I will do so once this gets
merged.
2023-10-22 10:27:42 +05:30
Erik Sundell
0d6c27ca1d Merge pull request #4603 from yuvipanda/nokpy
Remove links to okpy from docs
2023-10-16 06:58:42 +02:00
YuviPanda
b50fa894ad Remove links to okpy from docs
These were removed in
https://github.com/jupyterhub/oauthenticator/pull/691,
and now the link checker is not happy.
2023-10-16 09:49:50 +05:30
John Charankattu
1ed2c4d07d DOC change db_url schema from postgres to postgresql
sqlalchemy no longer supports postgres schema
2023-10-13 19:51:51 +05:30
Min RK
6905c75cea skip linkcheck for linux.die.net
links work, but site seems to block linkcheck requests from CI with 403
2023-09-29 11:10:45 +02:00
Min RK
1b7ca1e5de Merge pull request #4568 from LexiJess/main
Update gallery-jhub-deployments.md
2023-09-29 11:02:28 +02:00
Yuvi Panda
be96990258 Fix link syntax
Co-authored-by: Min RK <benjaminrk@gmail.com>
2023-09-27 10:37:22 -07:00
Jessie Hanson
f396c9910e Update gallery-jhub-deployments.md
Adding the Sirepo gateway to the list of Jupyter instances.
2023-09-13 09:53:17 -06:00
Min RK
27569bc97e Merge pull request #4508 from lrlunin/patch-1
Documentation for RTC for JupyterLab >= 4.0
2023-09-12 10:55:01 +02:00
Min RK
1141216758 pass public urls as JUPYTERHUB_PUBLIC_URL and JUPYTERHUB_PUBLIC_HUB_URL
to spawners and services
2023-09-12 10:45:29 +02:00
Yuvi Panda
4fe3fe8f12 Merge branch 'main' into pr/small-services-docs-fixes 2023-09-08 19:25:53 -07:00
YuviPanda
841913a1d1 Remove ~ from .HubOAuthenticated reference 2023-09-08 19:18:29 -07:00
Erik Sundell
906d528302 Merge pull request #4556 from minrk/moar-services
add some more service credential docs
2023-09-08 23:45:24 +02:00
Min RK
aa8d8300b1 BIDS Teaching video appears to be gone 2023-09-08 14:40:51 +02:00
Min RK
4838a5a8e5 another pass on oauth_redirect_uri 2023-09-07 18:35:09 +02:00
Min RK
77d7b88b01 Apply suggestions from code review
Co-authored-by: Erik Sundell <erik.i.sundell@gmail.com>
2023-09-07 18:30:08 +02:00
Min RK
d33d0f7dac further clarify Service inputs
- try to be clearer about url
- display only used with url
- doc oauth_client_id and oauth_redirect_uri
2023-09-07 17:11:55 +02:00
Min RK
85ef375cc5 add some more service credential docs 2023-09-06 13:45:59 +02:00
Erik Sundell
1eda00b721 Small fixes to services docs 2023-09-06 09:41:51 +02:00
Min RK
351b5c0c90 apply suggestion from review 2023-08-30 15:33:43 +02:00
Max Fröhlich
8c40f3207e Mention NomadSpawner
relates to https://github.com/jupyterhub/jupyterhub/issues/3860
2023-08-10 16:49:29 +02:00