search

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

Directing newcomers to the Jupyter Book/longer paper mattermost team #34

Open SNeuroble opened 3 years ago

SNeuroble commented 3 years ago

We invite people to join the Jupyter efforts on the landing page but I just realized we don't really point them towards how they can join. Should we at least direct them to the Jupyter Book channel?

htwangtw commented 3 years ago

The best way to make it happen is probably updating the front page with a link to the Mattermost Channel (https://mattermost.brainhack.org/brainhack/channels/brainhack_paper_jupyterbook). Any taker for a PR?

katjaq commented 3 years ago

hello :) oopsi, obviously we hadn't thought this one to the end 🙃 Thanks for the suggestions. Could be Mattermost; or just on GitHub via an issue? I made an issue template for questions – could be this one as well.

What do you think?

htwangtw commented 3 years ago

The issue template is great for tracking people who know what they want to bring! The difficult kind to catch is people who are interested but not sure where to start, hence the suggestion of mattermost. After the reach out through mattermost, we will eventually ask them to submit an issue. Everything comes back to Github issues for progress tracking. Another alternative is to add some onboarding info in README.md, together with a link to contribution guideline (issue #2). Of course, we won't catch everyone, but we can make sure we are doing our best :smiling_face_with_three_hearts:

katjaq commented 3 years ago

Sounds great! Thanks @htwangtw . I also love that you tagged it great first issue and invite new people to come and add the link(s) to Mattermost channel etc 💛 🚀 I do think that the onboarding in the readme should be there in addition! 🎉 💚 so we do our very best to make it easy for everyone 🥰 (contributors and maintainers 😊)

SNeuroble commented 3 years ago

Totally agree that having a link in both the landing page and readme and would be helpful! After we do that that, we may want to start thinking in the longer term about whether there should be some filter for bots etc. Maybe for now breaking up the link like xxx [at] yyy would start to help.

complexbrains commented 3 years ago

I guess contribution guideline is the biggest part of it for people to onboard regarding what processes are done in the book and how to use simple tools to start contributing towards.

I wrote in the related issue well-designed issue templates are also very helpful for the new comers to know what type of info they should be providing for what type of work to be completed, to make their job easier. So we need a bit of them as in Turing Way's book. I guess these might be good start as an addition to the ones you proposed too.

SNeuroble commented 3 years ago

I think there are two kinds of onboarding we're talking about: 1) looping people into the team specifically on mattermost, and 2) directing people how to contribute to the repo. This issue is specifically discussing the former while your issue discusses the latter. This issue's title could definitely have been more specific, so I'm updating it now!

In my opinion, this particular issue may be slightly higher priority, since we're already telling people that they can join but they have no way in!

yasminebassil commented 3 years ago

Hello! Just seeing this now, but I wanted to chime in with some thoughts :)

I definitely agree that new people should be directed to join the Mattermost first, and that there should be a "Mattermost Onboarding" section in the ReadMe. This way, new people can be slowly introduced to the group via Mattermost and the different efforts/initiatives/channels that we have going on there. Then after that, we could direct them to GitHub to create issues for any new ideas/contributions that they have.

I'd be more than happy to kickstart the ReadMe with some Mattermost onboarding information, if that helps! @SNeuroble are we looking to add information to it soon? I'd be happy to help! I think this is super important as new people join (especially to those who want to join the Jupyterbook efforts)

Side note - I also have thoughts about doing some cleaning/reorganizing of the Mattermost workspace itself as new people join (would anyone be interested in this? I think it could be much cleaner and efficient!) Let me know! I could start a new issue about it if needed.

htwangtw commented 3 years ago

Please feel free to submit a PR @yasminebassil. I am happy to help just drop me a line on mattermost if you need.

SNeuroble commented 3 years ago

Agreed—go for it and thank you, @yasminebassil ! 🙏🏽