brainhackorg / brainhack_jupyter_book

A Jupyter Book of everything Brainhack: past, present and future.
http://brainhack.org/brainhack_jupyter_book/
BSD 3-Clause "New" or "Revised" License
14 stars 29 forks source link

Create a short version of brainhack starter kit #87

Open htwangtw opened 2 years ago

htwangtw commented 2 years ago

cc @complexbrains @smoia @eurunuela

Sorry I was late - this item disappeared from my inbox....

Based on the existing long form checklist, here's the points I would include as a minimal version:

  1. Find some people to organise things with you
    • Global Contact the central organiser
    • Local Allocate the tasks to cohosts
  2. Logistics
    • In person: Find a venue with wifi and lots of extension cables, best takeaway in town
    • Virtual: Streaming platform and instruction to access
  3. Advertisement - make a webpage about when, where, schedule, and cost (if applicable)
  4. Projects
    • For small or first time event, provide a potential list of projects
    • Consider a theme for your Brainhack to help people come up with projects
  5. Find talks, tutorials, or activity for group engagement For Global edition: cross hub talks/interaction Reach out to Brainhack community for existing material
  6. Wrap up and feedback from participants
    • Certificate if applicable
    • (Global) Report back to the central organiser
htwangtw commented 2 years ago

cc @complexbrains @smoia @eurunuela Let's see if this is a good list and I can start a drafted PR

htwangtw commented 2 years ago

Optional material to link in the page: https://github.com/brainhackorg/bhg-event-materials

eurunuela commented 2 years ago

Thank you @htwangtw !

I will open issues for each of those points for newcomers to tackle during BHG 2021. Can we create a #newcomers label to make sure only newcomers work on them.

Does that sound ok to y'all? @htwangtw @smoia @complexbrains

htwangtw commented 2 years ago

I found #newcomers as vague as #good-first-issue - Is it new comer to what? It has some implicit assumption of brainhack community. It might work for project like this one, but not for a lot of other ones that has their own plan outside of the scope of brainhack. I would prefer to keep the good first issue tag, but explain more explicitly in the issue on what they can learn by doing the project. Add a #brainhackglobal-2021 tag along with #good-first-issue would be enough. They know they might get extra help at brainhack.

eurunuela commented 2 years ago

Do you have admin privileges to create the tag @htwangtw ? It won't let me create a new tag.

smoia commented 2 years ago

Hey all - sorry for the late reply. I thought the aim of the short list was to have it made by us before the events, and the rest of the long list would serve as GFI for newcomers later... did I misunderstand our intentions?

eurunuela commented 2 years ago

I thought we were going to come up with an outline that would serve as a to-do list (GFI) for longer writing made by newcomers.

smoia commented 2 years ago

I thought we were going to select the "important ones" and create a to-do list from what was left (which still seems a whole awful lot). But then again, maybe it's my misunderstanding. Pinging @htwangtw @complexbrains and @Remi-Gau for their thought on this.

htwangtw commented 2 years ago

Hey all - sorry for the late reply. I thought the aim of the short list was to have it made by us before the events, and the rest of the long list would serve as GFI for newcomers later... did I misunderstand our intentions?

My understanding is the same as @smoia We are doing this one - I can remove the brainhack global tag if this is causing confusions

Honestly I think overly detailed guideline is going to put first time organiser off. If it's their first time, they are likely trying to see if this format works for them. The aim is to get an event off the ground and running. For more established sites they will have their own preferred way to run it. I have a feeling that if we roll out lots of guidelines we might be missing both crowds.

complexbrains commented 2 years ago

I guess somewhere in between would be the best. The summary that @htwangtw has created is a very friendly and like a pill as a start up but we can also support each item with links and pointers to further reading and resources if they every into doing so. Eg. only the suggestion regarding having a website might be a hard thing to do as a start, if they do not know that we already provide a template ready to run under a GitHub repo.

So we might extend it a little bit more with these pointers and some additions but no further than 1-2 page reading indeed. We have the guideline and material repository for more details anyways.

smoia commented 2 years ago

Remember that the final aim is to transfer all the guidelines and checklists in the jupyter notebook to make them more different and easier to navigate (à la the Turing way).

Since this task takes time, but it is fairly easy, it is a great opportunity to be run as a project to help newcomers develop their git skills. At the same time, we want the most important information to be easily reachable before the bhg takes place.

@htwangtw took the challenge to decide what pieces of information were deemed important before the bhg. Those pieces will be added to the jupyter book by us now-ish.

@eurunuela took the challenge of splitting everything else into chunks that should be transformed into good first issues for the newcomers and opening those issues.

Sounds like a good reconstruction of what we discussed at the meeting? If so, let's split those points within us and adapt them to the jnb!

smoia commented 2 years ago

I like the idea of links and pointers, but can we link to parts of the written guidelines? I honestly don't remember if you can create anchors in Google docs

eurunuela commented 2 years ago

Thank you @smoia , that was very helpful. I somehow missed the following point:

Those pieces will be added to the jupyter book by us now-ish.

It sounds like it's all about deciding who will tackle each of the points in @htwangtw 's list.

htwangtw commented 2 years ago

Keeping the full guide to a page max would be great. Things doesn't have to be exact as the format of the event kept evolving. I start a branch in this repo, and people can submit PR to that branch to add content before we merge the content to the main branch.

The relevant file is here: https://github.com/brainhackorg/brainhack_jupyter_book/blob/event_guide/brainhack_book/host_an_event.md In the comments of the file I have added some links that can be used as examples based on the local event organiser meeting

In case anyone needs this: Set up a branch on your fork base on the upstream/event_guide branch and track it in your fork:

git clone git@github.com:USERNAME/brainhack_jupyter_book.git
cd brainhack_jupyter_book/
git remote add upstream git@github.com:brainhackorg/brainhack_jupyter_book.git
git fetch upstream
git checkout -b my_edits upstream/event_guide
git push origin HEAD -u

When creating a PR, select event_guide as the base