Zero-to-jupyterhub-k8s: Update documentation with link to Helm chart dependencies mapping

Created on 5 Jan 2019  路  8Comments  路  Source: jupyterhub/zero-to-jupyterhub-k8s

I think that it would be beneficial to include in _Z2JH documentation_ a link to a mapping table, indicating which versions/releases of JupyterHub Helm chart鈥檚 components - such as JupyterHub application per se - correspond to which versions/releases of the Helm chart. The mapping table itself should likely belong to _Z2JH Helm chart documentation_ (since it is a separate repo, I assume that it has a separate documentation).

Most helpful comment

@choldgraf My pleasure. Thank you, again!

All 8 comments

The helm chart is published in a separate repo, but this is where it is developed.

Perhaps we could have this in the README of this repo even?

@consideRatio I think that the optimal setup would be to have the mapping table in the chart repo's README (as you suggested) and/or the chart's documentation, if any, plus a mention and a link to that info in Z2JH documentation.

Just a note that I opened up https://github.com/jupyterhub/helm-chart/pull/94 to add a list of jupyterhub versions to that README. Would that be enough?

@choldgraf Great first step, thank you! As I've said earlier, I think that versioning should be documented in both Z2JH and Helm chart projects: with a mapping table in the former and a relevant link (with a very brief explanatory text - I suggest just to reuse the one that you have already added before the table) in the latter.

@ablekh I believe this was hammered out in #1106 and also here: https://github.com/jupyterhub/helm-chart#versions-coupled-to-each-chart-release

what do you think? is this issue resolved? :-)

@choldgraf Looks good to me. Thank you for making it a reality. One thing that I would add, though, is a column for versions of JupyterLab since it is bundled with JupyterHub and Z2JH chart. And I would remove "v." from column titles as IMO it's redundant. :-)

sounds good - and thanks for the tip! I'm gonna close this issue since I think the original problem is now resolved, though please feel free to open another to discuss making the table a bit better!

@choldgraf My pleasure. Thank you, again!

Was this page helpful?
0 / 5 - 0 ratings