Commit Graph

65 Commits

Author SHA1 Message Date
Simon Li
2942654f15 Fix another old requests URL 2025-07-04 15:00:13 +01:00
YuviPanda
3a9c631526 Provide consistent myst references to documentation pages
While doing https://github.com/jupyterhub/jupyterhub/pull/2726,
I realized we don't have a consistent way to format references
inside the docs. I now have them be formatted to match the name
of the file, but using `:` to separate them instead of `/` or `-`.
`/` makes it ambiguous when using with markdown link syntax, as
it could be a reference or a file. And using `-` is ambiguous, as
that can be the name of the file itself.

This PR does about half, I can do the other half later (unless
someone else does).
2024-06-10 19:11:51 -07:00
YuviPanda
7852dbc1dc Cleanup references 2024-06-10 18:31:36 -07:00
Erik Sundell
fd21b2fe94 docs: fix internal reference typo 2024-05-07 09:10:28 +02:00
Simon Li
f83c22ea0e services.md: idle-culler does not need admin 2024-03-14 15:12:20 +00: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
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
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
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
Duc Trung LE
2823c12552 Prevent creating managed servicesat runtime 2023-07-04 11:35:08 +02:00
Duc Trung Le
9a0d00fd69 Typo 2023-07-04 11:35:08 +02:00
Duc Trung Le
8cef59bdd7 Add documentation 2023-07-04 11:35:08 +02:00
Min RK
6bd0bb4b4a feedback from review in singleuser doc 2023-03-01 10:10:30 +01:00
alwasega
bc3ef4403f Resolved items as guided by @minrk comments 2023-02-28 11:58:45 +03:00
alwasega
9535fa3af1 Re-pushed files after merging main into references 2023-02-09 13:12:42 +03:00
alwasega
46be2c21e0 Pulled upstream changes and re-pushed files 2023-02-09 12:47:12 +03:00
alwasega
1837c33a56 Restructured references section of the docs 2023-02-09 12:25:07 +03:00
Min RK
593112807b resolve linkcheck failures
- several http->https
- a few page moves
- miniconda->miniforge
- remove rochester from gallery, which doesn't apepar to be publicly documented (may be accessible internally, but that's not for a public gallery)
2022-12-07 15:10:42 +01:00
pre-commit-ci[bot]
33fa9b953b [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
2022-11-24 08:41:13 +00:00
Min RK
de5fb1e7ce Merge branch 'main' into copyediting 2022-11-24 09:40:21 +01:00
Min RK
2ed84b0de1 typo in access:servers scope
it's not access:users:servers
2022-11-11 09:23:23 +01:00
lumenCodes
23506a25e5 applied PR change suggestions 2022-10-26 11:44:13 +01:00
lumenCodes
8ffa07e82d Update to the services.md 2022-10-26 11:44:13 +01:00
Min RK
b55eaae51f document oauth_no_confirm in services 2022-08-10 08:57:35 +02:00
Min RK
e4e4bf5ff4 next release is 3.0, not 2.4 2022-07-29 15:35:08 +02:00
Min RK
225ace636a call client-allowed scopes JUPYTERHUB_OAUTH_CLIENT_ALLOWED_SCOPES 2022-07-08 10:18:59 -07:00
Min RK
62b38934e5 store scopes on oauth clients, too
rather than roles, matching tokens

because oauth clients are mostly involved with issuing tokens,
they don't have roles themselves (their owners do).

This deprecates the `oauth_roles` config on Spawners and Services, in favor of `oauth_allowed_scopes`.

The ambiguously named `oauth_scopes` is renamed to `oauth_access_scopes`.
2022-06-08 12:26:48 +02:00
YuviPanda
3264463366 Document the 'display' attribute of services
Ref https://github.com/2i2c-org/infrastructure/issues/1301
2022-05-11 19:04:58 +05:30
Erik Sundell
672e19a22a Merge pull request #3815 from minrk/changelog-2.2
Changelog for 2.2
2022-03-07 14:32:56 +01:00
Min RK
8f18303e50 fix some links revealed by myst
mostly pre-myst markdown links
2022-03-04 10:41:20 +01:00
Min RK
9c498aa5d4 Document HubOAuth.get_token for requests on behalf of users 2022-03-01 10:05:17 +01:00
Thorin Tabor
55f0579dcc idle-culler example config missing closing bracket 2022-02-22 13:16:37 -08:00
Min RK
db3b2d8961 refine service auth docs
favor HubOAuth, as that should really be the default for most services

- Remove some outdated 'new in' text
- Remove docs for some deprecated features (hub_users, hub_groups)
- more detail on what's required
2021-11-30 10:48:53 +01:00
Min RK
202b2590e9 doc: remove redundant TOC from services doc
The same TOC is automatically generated on the sidebar, no need for a manual copy
2021-11-30 09:18:57 +01:00
Min RK
12ab53fb37 changelog for 2.0
remove suggestions of `admin` permissions, in favor of roles and scopes
2021-09-13 13:44:32 +02:00
IvanaH8
12ffc42114 Fix docstring indentation and reference to flask example in docs
example using flask for Implementing your own Auth with JupyterHub was not displayed
2021-06-18 11:07:33 +02:00
0mar
7a3b237bb3 Refactored scope names and updated docs to reflect this 2021-06-15 13:00:15 +02:00
Min RK
4a0fed1a5b address review in services doc 2021-06-08 09:35:45 +02:00
Min RK
40de16e0e1 Update service examples and documentation with access scopes and roles 2021-06-07 14:02:13 +02:00
Min RK
4e41a39b30 Sync with main 2021-05-12 16:08:03 +02: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
863b4c7d50 Deprecate and remove some old auth bits
- remove long-deprecated `POST /api/authorizations/token` for creating tokens
- deprecate but do not remove `GET /api/authorizations/token/:token` in favor of GET /api/user
- remove shared-cookie auth for services from HubAuth, rely on OAuth for browser-auth instead
- use `/hub/api/user` to resolve user instead of `/authorizations/token` which is now deprecated
2021-05-05 14:07:14 +02:00
Min RK
9331dd13da run pre-commit (prettier) 2021-02-12 15:25:58 +01:00
sangarshanan
8ede924956 Remove extra paranthesis 2020-12-11 13:15:13 +05:30