search

2i2c-org / infrastructure

Infrastructure for configuring and deploying our community JupyterHubs.
https://infrastructure.2i2c.org
BSD 3-Clause "New" or "Revised" License
105 stars 64 forks source link

Create some "getting started" material for newcomers to Jupyter #1415

Open choldgraf opened 2 years ago

choldgraf commented 2 years ago

Context

There are many cases where 2i2c hubs are used by newcomers to the Jupyter / PyData / etc ecosystem. Sometimes those newcomers aren't in an environment where they get a lot of introductory material from the instructors (e.g. as part of a hackweek). In these cases, it would help them make rapid progress if they had some high-quality notebooks / instructions / etc that they could follow in order to learn quickly on a hub.

ref: this was also noted in the Jack Eddy event:

A hub that starts with a directory of simple tutorials (and a minimal kernel that satisfies the needs of those tutorials) would be a good default "base hub" feature. Additional hub areas and custom kernels could be created depending on the subject/workshop area.

Proposal

We should define a minimal set of "getting started" notebooks that work with the "base JupyterHub environment", and an easy way for hub users to grab copies of those notebooks themselves in order to learn more what they can do with Jupyter / JupyterLab / etc.

Updates and actions

No response

dan800 commented 2 years ago

@fperez created two intro folders for the Jack Eddy event here: https://github.com/jack-eddy-symposium/intro-git-jupyter One for git and one for jupyter. They would be great starter notebooks. As an aside, I'd also suggest that sorting authentication ahead of future events (e.g., by git id or orcid id) would help with getting the most out of these hubs. I think this could be handled part of event registration. @fperez also created a small notebook that authenticated from the hub to git that made life a lot easier during the event.

edit: I see that 2i2c-org/features#12 already is addressing my concern.

fperez commented 2 years ago

Thx @dan800 - I actually plan on updating those tutorial materials with the auth information; they are a bit old and that functionality didn't exist when I originally wrote them.

BrainonSilicon commented 2 years ago

Hi 2i2c team! I'm jumping in to say that I'd love to collab and share what our Community Management team is currently gathering together as part of some GitHub onboarding (I'm one of the Community Managers at The Alan Turing Institute).

jmunroe commented 2 years ago

I agree that there should be some "getting started" notebooks that try and ramp up users ("60 seconds to Jupyter", "Your first 5 minutes in Python", "Quickstart to using Python and Jupyter", or similar kind of thing) that are available for users as soon as they log in to a hub. This documentation does not need to be comprehensive but could point to additional material for further information. The goal could be to ensure users feel like they know just enough to able to participate in the hackweek / workshop / course / community.

I know that there are many resources already out there aimed at intro to python, pydata, jupyter, visualization, git, etc. We should try and pull content from those "upstream" sources where possible. If the Turing Institute has such materials that would be awesome, but I'll note that Project Pythia's Foundations book may be a good source.

BrainonSilicon commented 2 years ago

For sure! It's work that's been done so many times, but having just that personal small welcome and then pointing out to resources feels like there's actually someone who curated that welcome for that community which is always a nice vibe.