zero-to-jupyterhub-k8s
zero-to-jupyterhub-k8s copied to clipboard
Update documentation about `hub.config`
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
From @manics in https://github.com/jupyterhub/zero-to-jupyterhub-k8s/pull/3266#issuecomment-1824338932
I think we can either say
- use
hub.configwhere 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)
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