Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation about hub.config #3271

Open
consideRatio opened this issue Nov 23, 2023 · 2 comments
Open

Update documentation about hub.config #3271

consideRatio opened this issue Nov 23, 2023 · 2 comments

Comments

@consideRatio
Copy link
Member

consideRatio commented Nov 23, 2023

I think the for hub.config should be refined to:

  • list exceptions when using it causes problem, like hub.baseUrl
  • warn or error if known exceptions are configured via NOTES.txt
  • suggest that its fine to use for other things except for the exception

Context

values.schema.yaml entry defining the docs for hub.config

`hub.config` reference docs rendered

image

@consideRatio
Copy link
Member Author

From @manics in #3266 (comment)

I think we can either say

  • use hub.config where there is no explicit chart config (easiest for us)
  • or list the properties than can be set with hub.config (more work as we need to keep it up to date)

@minrk
Copy link
Member

minrk commented Nov 27, 2023

Yeah, I think in general, hub.config should link to the jupyterhub api reference, which contains docs for configuration, and we should only cover what folks shouldn't put in there. In general, I think most config should be in this passthrough going forward, unless z2jh needs to handle it specially.

It may be relevant to also link to the config docs for each of the bundled packages, e.g. kubespawner and oauthenticator

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants