Issue triage report - an overview of requested improvements

[consideRatio]

Locked temporarily

I'd prefer not to clog this issue with comments before I can steer the discussion and suggest concrete actions etc. I'm working to significantly reduce the numbers of open issues in this repo, but want to ensure we collect relevant points from them along the way.

Action points

• Go through all PRs and try merge/close
• Go through all issues
• Process the collected tasks constructively somehow

Documentation improvements

• Documentation on Z2JH configuration to make JupyterHub API requests - wish reference 1, ref 2.
• Documentation of "squishier questions like why you'd want to use it, how it benefits teaching in the classroom, and how to use it most effectively." - wish reference
• Docs summarizing NFS insights - ref1, ref2, ref3, ref3, ref4
• Documentation about information security, is this deployment GDPR compliant for example? ref 1.
• Documentation related to bare metal clusters, such as the need to install MetalLB, and configure a default StorageClass resource that works. ref 1, ref2, ref3, ref4 overview summary, ref5, ref6
• Documentation on how to adjust JupyterHub templates and such in z2jh ref1, ref2
• Document / make a note about scaling limitations in the resource sections ref1
• Promote the Used by page ref1, and perhaps mention specific curated deployments where users can learn some configuration tricks.
• Refresh the debug section, include kubectl edit and kubectl exec for example. ref1
• Debug/Troubleshooting section for cluster-autoscaler matters would be useful, describing the inspection of the cluster-autoscaler-status configmap in kube-system for example. Perhaps something about tolerations and taints also, or maybe the node-autoprovisioner by google. ref1
• A helm troubleshooting section could be useful ref 1.
• Documentation providing an overview of the pods/components ref1
• Documentation providing an overview of the configuration system ref1.
• Documentation providing an overview of the networking ref1
• Documentation providing insights into how the hook-image-awaiter and hook-image-puller interact
• A note about when z2jh is good, and when tljh is good, to provide for users before they get started early on. ref1.
• Overview of considerations for building a custom docker image for users ref1
• Overview of considerations for building a custom docker image for the hub pod ref1, ref2
• There are tools like nbzip, nbresuse, nbgitpuller and other which can be useful to add to the user environments, is there a sensible place to give some advice on such tools perhaps? ref1
• Reword setup-jupyterhub.rst with regards to the provided IP, to prepare users its actually sometimes a domain name. ref1
• Reword user-resources.rst section to clarify not all separate users get individually set resource requests ref1
• Documentation about the High Availability status of this Helm chart ref1, ref2
• Documentation about installing common packages without rebuilding images etc ref1
• Meta docs about the authenticator section, to describe our thinking of what we can support in Z2JH for example - wish reference
• Document for developers how to make a changelog in the repo's RELEASE.md file ref1
• Update LDAPAuthenticators docs in z2jh ref1
• Provide info somewhere relevant about the creation of PVCs happen once, and that cleanup of them is manual ref1, ref2 - Resolved in KubeSpawner 1.0.0 + JupyterHub 1.4.1
• Warn about overriding previous configuration in YAML, as a note part of the configuration reference ref1. - Considered solved by schema validation.
• hub.baseUrl isn't documented, along with many other things as listed in schema.yaml: not all configuration options are documented #1829. ref1

Maintenance

• Deprecate whitelist config in favor of allowlist
• Sustainable configuration of authenticators, where our jupyterhub_config.py section should not need to be kept in sync with the authenticator - ref0, ref1, ref2, ref3, ref4, ref5, ref6, ref7, ref8, ref9, ref10, ref11, ref12 - ref on how to go about this

[manics]

This is awesome!

[GeorgianaElena]

😍