Adding a contributor onboarding page

[jduckles]

• Draft an onboarding page content and decide where it should live in the Team Compass

This work stream will depend on:

• Update project Overview Page linked to / dependent on Find places where JupyterHub need to update its self-referential prose #845 and Revisiting the JupyterHub Mission, Purpose & Vision #850
• Create a repositories and codebase page to help understand what the offical JH repos are and Code Structure documentation
• Normalize CONTRIBUTING.md and their instructions across the various JupyterHub repositories. #852
• Audit / update contribution page and contribution guidelines
• Audit / update a dev environment setups page
• Audit / update - JupyterHub the Hard Way
• Update roadmap page - with an eye toward upcoming Roadmap Workshop Roadmap Workshop for JupyterHub and Binder - 25-26 February 2026 #805

[choldgraf]

just noting that we should distinguish between jupyterhub the technology (with documentation at jupyterhub.readthedocs.io) and jupyterhub the project, with documentation roughly split between jupyterhub-team-compass.readthedocs.io, and hub.jupyter.org. If folks think it's too confusing to have both resources, that's fine and we can remove one of them, but I'm just noting that both exist!

[kellyrowland]

notes on item "Normalize CONTRIBUTING.md and their instructions across the various JupyterHub repositories."

• there are 75 repos under https://github.com/orgs/jupyterhub/repositories?type=all
• the contributor guide linked from multiple CONTRIBUTING.md files is at https://docs.jupyter.org/en/latest/contributor/content-contributor.html and is currently a 404 and needs to be updated to https://docs.jupyter.org/en/latest/contributing/content-contributor.html everywhere (or maybe a redirect instead?)

files with significant content:

• https://github.com/jupyterhub/jupyterhub/blob/main/CONTRIBUTING.md
• https://github.com/jupyterhub/ltiauthenticator/blob/main/CONTRIBUTING.md
• https://github.com/jupyterhub/ldapauthenticator/blob/main/CONTRIBUTING.md
• https://github.com/jupyterhub/kubespawner/blob/main/CONTRIBUTING.md
• https://github.com/jupyterhub/nativeauthenticator/blob/main/CONTRIBUTING.md
• https://github.com/jupyterhub/oauthenticator/blob/main/CONTRIBUTING.md
• https://github.com/jupyterhub/repo2docker/blob/main/CONTRIBUTING.md
• https://github.com/jupyterhub/tmpauthenticator/blob/main/CONTRIBUTING.md
• https://github.com/jupyterhub/traefik-proxy/blob/main/CONTRIBUTING.md
• https://github.com/jupyterhub/zero-to-jupyterhub-k8s/blob/main/CONTRIBUTING.md
• https://github.com/jupyterhub/jupyter-server-proxy/blob/main/CONTRIBUTING.md
• https://github.com/jupyterhub/action-k8s-await-workloads/blob/main/CONTRIBUTING.md
• https://github.com/jupyterhub/systemdspawner/blob/main/CONTRIBUTING.md
• https://github.com/jupyterhub/mybinder.org-user-guide/blob/main/CONTRIBUTING.rst
• https://github.com/jupyterhub/repo2docker-action/blob/master/CONTRIBUTING.md

files that are nearly blank:

• https://github.com/jupyterhub/configurable-http-proxy/blob/main/CONTRIBUTING.md
• https://github.com/jupyterhub/jupyterhub-deploy-docker/blob/main/CONTRIBUTING.md
• https://github.com/jupyterhub/dockerspawner/blob/main/CONTRIBUTING.md
• https://github.com/jupyterhub/chartpress/blob/main/CONTRIBUTING.md
• https://github.com/jupyterhub/binderhub/blob/main/CONTRIBUTING.md
• https://github.com/jupyterhub/sudospawner/blob/main/CONTRIBUTING.md
• https://github.com/jupyterhub/pytest-jupyterhub/blob/main/CONTRIBUTING.md
• https://github.com/jupyterhub/batchspawner/blob/main/CONTRIBUTING.md
• https://github.com/jupyterhub/jupyter-rsession-proxy/blob/main/CONTRIBUTING.md
• https://github.com/jupyterhub/jupyterhub-deploy-hpc/blob/master/CONTRIBUTING.md
• https://github.com/jupyterhub/jupyterhub-deploy-teaching/blob/master/CONTRIBUTING.md
• https://github.com/jupyterhub/wrapspawner/blob/master/CONTRIBUTING.md
• https://github.com/jupyterhub/jupyterhub-tutorial/blob/master/CONTRIBUTING.md

repos with no CONTRIBUTING.md:

• https://github.com/jupyterhub/jupyterhub-idle-culler
• https://github.com/jupyterhub/jupyterhub-container-images
• https://github.com/jupyterhub/gh-scoped-creds
• https://github.com/jupyterhub/autodoc-traits
• https://github.com/jupyterhub/escapism
• https://github.com/jupyterhub/the-littlest-jupyterhub
• https://github.com/jupyterhub/pebble-helm-chart
• https://github.com/jupyterhub/simpervisor
• https://github.com/jupyterhub/action-get-quayio-tags
• https://github.com/jupyterhub/team-compass
• https://github.com/jupyterhub/grafana-dashboards
• https://github.com/jupyterhub/jupyter-remote-desktop-proxy
• https://github.com/jupyterhub/helm-chart
• https://github.com/jupyterhub/docker-image-cleaner
• https://github.com/jupyterhub/action-major-minor-tag-calculator
• https://github.com/jupyterhub/action-k8s-namespace-report
• https://github.com/jupyterhub/nbgitpuller
• https://github.com/jupyterhub/action-k3s-helm
• https://github.com/jupyterhub/firstuseauthenticator
• https://github.com/jupyterhub/jupyterhub-python-repo-template
• https://github.com/jupyterhub/binder-data
• https://github.com/jupyterhub/design
• https://github.com/jupyterhub/.github
• https://github.com/jupyterhub/jupyterhub.github.io
• https://github.com/jupyterhub/jupyterhub-sphinx-theme
• https://github.com/jupyterhub/pamela
• https://github.com/jupyterhub/jupyterhub-the-hard-way
• https://github.com/jupyterhub/nbgitpuller-downloader-plugins
• https://github.com/jupyterhub/nbgitpuller-downloader-googledrive
• https://github.com/jupyterhub/nbgitpuller-downloader-dropbox
• https://github.com/jupyterhub/nbgitpuller-downloader-generic-web
• https://github.com/jupyterhub/binder-billing
• https://github.com/jupyterhub/kerberosauthenticator
• https://github.com/jupyterhub/jupyterhub-on-hadoop
• https://github.com/jupyterhub/mybinder-tools

archived repos not included.

[afterthesegfault]

Hello @jduckles I would like to help with this in anyway I can. Any guidance on where to start will be appreciated. Thank you!

[jduckles]

Hey @minrk can you connect @afterthesegfault with Shane to nudge this forward?

[minrk]

@afterthesegfault thanks for your PR #859! if you're still interested, I'd be happy to help you get started moving on some of these other tasks.

[afterthesegfault]

Hi @minrk, thanks! I'm still interested in contributing. I'm happy to pick up a task and work through it.

[minrk]

@afterthesegfault great! Would you like to take a stab at updating contributing/guide/index.md with the content from this draft?

[afterthesegfault]

Okay. Will work on it and have a PR for review by next week.

[afterthesegfault]

Hi @minrk, I’ve opened a draft PR for this here: Onboarding-guide

I’d love to get your initial thoughts on the overall approach before I polish it up and mark it ready for formal review. Specifically, I want to make sure adding the contributor guide into step 7 aligns with what you had in mind.

Let me know what you think!

[KirstieJane]

Hi @afterthesegfault - I'm following along with your PR #916 and I think it makes sense for @sbonaretti to be the person who reviews this contribution with you, is that ok?

Serena is our new community manager and so working with you on improving how we communicate the contributor pathway would be -- I hope -- mututally beneficial!

The one caveat is that she's at a Jupyter Book workshop this week AND she's onboarding to JupyterHub herself and so might not have time to review and work with you super quickly - maybe early July is a reasonable estimate.

Thank you so much for your contributions so far - sorry if this feels slower - but I actually think its going to get us to a really strong place for future contributors! 🙏

[afterthesegfault]

Hi @KirstieJane

Thanks for the follow along. I'm totally fine with @sbonaretti taking over the review. Given the focus of the PR, her perspective sounds like a great fit, and I'm happy to work with her on it.

No worries about the timeline either — early July sounds reasonable. I appreciate the heads-up, and I'm glad to hear this work could help strengthen the contributor experience going forward. It gives me ample time to finish up the PR and have it ready for a formal review."

Thanks again for the support and for helping move this forward! 🙏

[sbonaretti]

Thanks @afterthesegfault ! Back to you ASAP!