jupyterhub / zero-to-jupyterhub-k8s

Helm Chart & Documentation for deploying JupyterHub on Kubernetes
https://zero-to-jupyterhub.readthedocs.io
Other
1.52k stars 791 forks source link

Update documentation about `hub.config` #3271

Open consideRatio opened 9 months ago

consideRatio commented 9 months ago

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

Context

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

`hub.config` reference docs rendered ![image](https://github.com/jupyterhub/zero-to-jupyterhub-k8s/assets/3837114/e443ba7c-abd9-4624-b81f-acb36b571153)
consideRatio commented 9 months ago

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)
minrk commented 9 months ago

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