Skip to content

[WIP] 馃毀 Updating the guide.mdby adding the Contributor Onboarding guide to it. - #916

Draft
afterthesegfault wants to merge 6 commits into
jupyterhub:mainfrom
afterthesegfault:Onboarding.md-Docs
Draft

[WIP] 馃毀 Updating the guide.mdby adding the Contributor Onboarding guide to it.#916
afterthesegfault wants to merge 6 commits into
jupyterhub:mainfrom
afterthesegfault:Onboarding.md-Docs

Conversation

@afterthesegfault

@afterthesegfault afterthesegfault commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR updates guide.md by adding a Contributor Onboarding Guide to help new contributors get started more effectively.

Changes

  • Added a dedicated Contributor Onboarding section.
  • Reorganized content to improve document flow and readability.
  • Removed repetitive information and consolidated overlapping guidance.
  • Improved overall cohesiveness and consistency across the document.

Impact

These changes make the guide easier to navigate, provide a smoother onboarding experience for new contributors, and improve the overall quality of the documentation.

issue: #851

@afterthesegfault
afterthesegfault marked this pull request as draft June 15, 2026 12:59
@afterthesegfault afterthesegfault changed the title Updating the guide.mdby adding the Contributor Onboarding guide to it. [WIP] 馃毀 Updating the guide.mdby adding the Contributor Onboarding guide to it. Jun 15, 2026
@KirstieJane

Copy link
Copy Markdown
Collaborator

Would you mind linking to the issue at the top of your PR comment @afterthesegfault please? Just so its really easy to jump back and forth 馃檹

@afterthesegfault

afterthesegfault commented Jun 17, 2026

Copy link
Copy Markdown
Contributor Author

Thanks @KirstieJane, I see that @minrk already linked the issue. This is an awesome way to improve on the guidelines for getting a PR merged on the document. A simple reminder to link the issue the PR aims to fix, resolve or close to make it easier for collaborators and reviewers to find the issue you are working on.

Comment thread docs/contribute/guide.md Outdated
@afterthesegfault afterthesegfault changed the title [WIP] 馃毀 Updating the guide.mdby adding the Contributor Onboarding guide to it. [MRG] 馃毀 Updating the guide.mdby adding the Contributor Onboarding guide to it. Jul 17, 2026
@afterthesegfault afterthesegfault changed the title [MRG] 馃毀 Updating the guide.mdby adding the Contributor Onboarding guide to it. [MRG] Updating the guide.mdby adding the Contributor Onboarding guide to it. Jul 17, 2026
@afterthesegfault
afterthesegfault marked this pull request as ready for review July 17, 2026 14:32

@minrk minrk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR! Consolidating some review from our collaboration cafe today.

I think the only thing we really need before merging is clarifying the audience for the document and some updates to the setup step to clarify who that section is for.

Comment thread docs/contribute/guide.md
Comment thread docs/contribute/guide.md
- Have a read through of the case studies and see the many ways JupyterHub is enabling learning, science and creativity globally.

## Step 3: Set Up Your Environment and/ or deploy your first JupyterHub
The first thing you should do is to determine what *type* of JupyterHub deployment will eventually meet your requirements:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think a point that's missed here is that which of these is highly dependent on what the contributor's goal is. If this is someone learning how to set up to make a PR, installing tljh or z2jh is very unlikely to be the right choice, instead a standard pip install -e . is the right one, like every other Python package. But if you already have a deployment, then you likely already have an answer to this question.

From Kirstie: this document is too long, in part because it is one document that includes too many mutually exclusive branches. Should these setup/installation steps be a separate page(s)?

Let's try this: start this section with:

If you haven't deployed JupyterHub and would like to try it out to learn more about how it works, there are a few ways to do it.
If you are interested in contributing a specific change to a specific repository, follow that repo's specific contributing/development installation documentation.
If you already have a deployment you are working with, skip this section unless you are interested in learning about different ways to deploy JupyterHub.

Comment thread docs/contribute/guide.md
Comment thread docs/contribute/guide.md
Comment thread docs/contribute/guide.md
@afterthesegfault
afterthesegfault marked this pull request as draft September 10, 2026 10:46
@afterthesegfault afterthesegfault changed the title [MRG] Updating the guide.mdby adding the Contributor Onboarding guide to it. [WIP] 馃毀 Updating the guide.mdby adding the Contributor Onboarding guide to it. Sep 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants