Skip to content

Docs: clarify that Ingress is a prerequisite for JupyterHub

Tristan requested to merge docs-kubernetes-jupyter-app-update into master

What does this MR do?

Currently, our documentation that describes the various managed apps that can be installed through our Kubernetes integration does not make a mention in the section for JupyterHub that it requires that Ingress already be installed.

While Helm Tiller is also a prerequisite, I believe the note at the top of the "Installing Applications" section that states: Install Helm Tiller first because it’s used to install other applications covers that.

This MR adds a statement that Ingress must be installed first and have an IP address assigned before JupyterHub can be installed.

Related issues

Closes #49865.

Author's checklist

  • Follow the Documentation Guidelines and Style Guide.
  • Link docs to and from the higher-level index page, plus other related docs where helpful.
  • Apply the ~Documentation label.

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Thong Kuah

Merge request reports