zero-to-jupyterhub-k8s icon indicating copy to clipboard operation
zero-to-jupyterhub-k8s copied to clipboard

Update documentation about `hub.config`

Open consideRatio opened this issue 2 years ago • 2 comments
trafficstars

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 avatar Nov 23 '23 12:11 consideRatio

From @manics in https://github.com/jupyterhub/zero-to-jupyterhub-k8s/pull/3266#issuecomment-1824338932

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)

consideRatio avatar Nov 23 '23 12:11 consideRatio

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

minrk avatar Nov 27 '23 08:11 minrk