# Drafting a JupyterHub Contributor Onboarding Landing Page

_The idea with this work is to create a contributor landing page that tries to pull together key areas of JupyterHub Documentation and the Team Compass to invite new contributors, give them a sense of the project, and support and challenge them to setup a development environment (if they have dev interest._

## Actions / Issues to address before release of onboarding page

- [ ] Update project [Overview Page](https://jupyterhub.readthedocs.io/en/stable/index.html)
- [ ] Audit / test a [dev environment setup](https://jupyterhub.readthedocs.io/en/stable/contributing/setup.html) page
- [ ] Create a repositories and codebase page to help understand what the offical JH repos are and Code Structure documentation
- [ ] Update / Audit [contribution page](https://jupyterhub.readthedocs.io/en/stable/contributing/index.html) and contribution guidelines
- [ ] Update [roadmap page](https://jupyterhub.readthedocs.io/en/stable/contributing/roadmap.html)

# Welcome to the Jupyter Hub: Contributor Onboarding Guide

## Introduction

Welcome to JupyterHub! This guide will help you get started as a contributor through a series of self-paced activities. By the end, you'll have a good understanding of the project, how to contribute, and how to engage with our community.

JupyterHub is a multifaceted piece of infrastructure which can be used in many ways. It is used in academic institutions as a key piece of infrastructure to bring interactive computing environments to learners. These can be Jupyter Notebooks, RStudio Sessions, marimo etc or any interactive web page environment. While it doesn't have to be run with kubernetes, you'll find many production deployments use kubernetes. JupyterHub is a relatively low-level piece of critical infrastructure for many large scale computational learning environments worldwide. If you have needs for bringing web-based interactive computing services to your learners, JupyterHub might be the right piece of kit for you. JupyterHub also provides the foundation for the [mybinder.org](https://mybinder.org/) ad hoc Jupyter environment service.

## Step 1: Understand Our Mission and Vision

- Read our [Project Overview](https://jupyterhub.readthedocs.io/en/stable/index.html) 
- Activity: Reflect on how our mission aligns with your interests and goals, share those reflections in your "Hello Jupyter Hub" note (Template Below)

## Step 2: Set Up Your Environment and/or explore JupyterHub The Hard Way

### Option 1 -

_If you're interested in making development contributions, this will help you get started._

- Follow our [Development Environment Setup Guide]() (15-20 minutes)
- Run the test suite in your environment.
- Activity: Submit a PR to the Development Environment Setup Guide page for any setup problems you encounter in your environment.

### Option 2 -

_If you're interested in installing or administering a JuptyerHub this documentation will help you learn about the various moving parts._

- Explore [JupyterHub the hard way](https://github.com/jupyterhub/jupyterhub-the-hard-way/tree/master)
- Activity: As you step through JupyterHub the hard way, submit any issues or challenges you encounter to the repo as issues (bugs) or pull requests (fixes).

## Step 3: Explore the Codebase and Team Compass

- Review our [Code Structure Documentation](https://github.com/jupyterhub/jupyterhub) 
- [SUGGEST AREAS OF TEAM COMPASS TO READ]

## Step 4: Understand the Contribution Process

- As a Jupyter sub-project, please read Project Jupyter's [Contribution Guidelines](https://docs.jupyter.org/en/latest/contributing/content-contributor.html)) 
- Challenge: Identify one area where you think you could contribute to improve JupyterHub (code, documentation, testing, design, etc.) and add it to your "Hello message"

## Step 5: Engage with the Community

- Join our [Zulip Chat](https://jupyter.zulipchat.com/#narrow/channel/469744-jupyterhub) and introduce yourself
- Check out the Jupyter Forum (https://discourse.jupyter.org/) and [Jupyter Hub Category](https://discourse.jupyter.org/c/jupyterhub/10) on the forum. Review a few of the recent posts and familiarize yourself with the community and its conversations.
- Have a look at open Issues on [jupyterhub/jupyterhub](https://github.com/jupyterhub/jupyterhub/issues)
- Attend a community meeting (schedule in Team Compass, [Jupyter Community Calendar](https://discourse.jupyter.org/t/jupyter-community-calendar/2485))

## Step 6: Make Your First Contribution

_This step is probably best done after a few days or weeks of lurking and seeing how things go in the community._

- As you've gone through the documentation and [Team Compass](https://github.com/jupyterhub/team-compass), have you found anything that needs updating / improving?
- Follow our [Step-by-Step Contribution Guide]() to submit your first pull request

## Additional Resources

- [Team Compass]() : Learn about our community structure and governance
- [Code of Conduct](): Understand our community standards
- [Project Roadmap](): See where we're headed and how you can help

## Live Sessions

[[ QUESTION: _Does the community want to commit to these kinds of sessions? Perhaps making one of the Collaboration Cafes have an onboarding 30-min could make this work_ ]]

We run live onboarding sessions once per quarter to help new contributors get started and meet the community. Check our [Events Calendar]() for the next session.

## Engagement Checklist

If you're excited about our project and want to stay involved, here are some next steps:

- [ ]  Subscribe to our mailing list for project updates
- [ ]  Attend a community meeting (schedule in Team Compass)
- [ ]  Complete your first pull request
- [ ]  Help another new contributor in the forums or Zulip channel
- [ ]  Sign up for a mentorship program (if available)

## Hello Message Template

Hello Jupyter Hub! I'm {{name}} from {{location}}.
I'm excited to {{primary_goal}} and learn more about {{specific_interest}}.
My background is in {{background}} and I hope to contribute by {{contribution}}.
Looking forward to collaborating with everyone!

Remember, contribution isn't just about code. Documentation, testing, design, and community support are all valuable ways to contribute!

We're thrilled to have you join us! If you have any questions along the way, don't hesitate to ask in our community channels. Happy contributing!