Diverse operation manuals for CodeRefinery workshops and lesson design.
Home Page: https://coderefinery.github.io/manuals/
License: Creative Commons Attribution 4.0 International
As it might be quite confusing for first time EL / first time CR-ers when explaining the setup, maybe it could be tried to actually show it during onboarding. Ie instructors (EL onboarding organizers) are in twitch, we use hackmd for communication and we show the EL material in simialr way as we would do a lecture, then we "do exercise" and come to zoom to discuss more?
I know it is not focused on CodeRefinery lesson design but I find it very helpful. I use a lot the Carpentries styles to create new lessons.
I am happy to add the link if you think it is useful.
Also exercise editing the hackmd as ice-breaker by asking for a roll-call or similar.
This came up now in a meeting and Richard adds it to the mega-CR event.
And we should not forget to add it to the manuals.
CC-BY-SA is used for other lessons. Should these manuals be more liberal, CC-BY? I'm happy with either.
Incidentally I saw that website repo doesn't have a license...
To make sure all instructors and helpers know this in advance.
in mega workshops sometimes hackmd gets difficult for participants to edit
In zoom it's important to start recording in the form you want the video to be in (e.g. start recording when screen is shared so that it stays there):
https://support.zoom.us/hc/en-us/articles/360025561091-Recording-layouts
In our course, I just happened to get it right, but I think there was a real chance our recording would have been useless. I think this is important to investigate before any course. I don't yet know enough to say what must be done (and could be done).
also, consent to be recorded: https://support.zoom.us/hc/en-us/articles/360026909191-Consent-to-be-Recorded
Lesson design is very nice but some information on how to create a new lesson (not to design it) is missing.
Does it make sense to add a section on how to create a CodeRefinery lesson (with CodeRefinery lesson template, etc.). I would be interested because so far I only use Carpentries lesson template.
since both watching and doing is hard, it's better if we can minimize the type-along demands. If it's done, it should be extremely slow - almost slow enough to be a demo and then separate exercise session after, since there is no room for if people get lost.
The lack of automated waiting list in Indico event registration system that we use was discussed here:
https://docs.google.com/document/d/1vxeBmjoOWiJ8McFOzJpEbHcU1oWG5hsTiLAJFdW6HhE/
Document the conclusion of that discussion in the manuals.
I never know how to make challenges/tasks/solutions, etc. And I don't know when to use each of them. I would appreciate a document describing what the CR-specific markdown constructions are, a brief example, and when each should be used.
Then you watch there what you screen share (crop, font size) and possibly use it to manage breakout rooms. Also on the second laptop you can see the chat (I could not see the chat while screen sharing).
Observation by Lucy:
There were some participants who were a bit more advanced and they were reluctant to use the green stickies. But I think the stickies only work if everyone uses them, so keep pushing for those greens from everyone when they are happy.
Lucy:
instructors used terminal auto-complete but a participant didn't know how to use this (perhaps this was outlined at the start of the workshop and I missed it)
We should either comment on this and show how it works or not use it.
Not sure this is the best place to track it but want to save it somewhere:
Received as feedback after the first full online workshop:
If I could say something to improve, the breakout rooms would've been nice to be up during the breaks just after the breakout sessions (perhaps with a notification about the styart of the break or make people rejoin the room if they want to be there). Especially for the ones who joined the course as a group like us, we liked discussing the topics and other topics during the breaks aswell. Keep it up!
Some role mentions in workshop playbook do not have links to the respective titles.
This is used for collaborative note taking.
We could add:
"Are you collaborating with others on a version-controlled project? What's the size of your team?"
to the list of icebreaker questions. Would fit the day the Git collab lesson is taught.
The manual recommends to create new events by copying old ones (good) with also copying ACLs (access control lists).
The latter is problematic and we should remove it. The reason is that if we add staff access, they keep access to all later workshops then, possibly after they have left the CR team.
to fit also workshops that don't have zoom
Few points before I forget:
\hand seems to be standardOne thing that I noticed during merging few pages is that there seem to be multiple different ways of linking internal/external pages, which sometimes makes work on these pages a bit confusing.
Ideas from RSE coffee break
Moved from coderefinery/installation#91
With the new OBS setup used in May workshop, it may be that the host has to turn off participants videos in the main room to make sure they are not streamed.
If one participants video got turned off by host, it cannot be turned on by themselves in breakoutroom, but a host/cohost need to go to the breakoutroom and click 'ask to share video' to make it possible for them to turn on video.
If the new setup is kept, then this should be mentioned in exercise leader onboarding. -> less confusion -> faster action -> more time to focus on exercise.
If possible, it would be great to resolve this otherwise. Tests to be done.
currently we only send an email ~1 week before workshop with installation instructions. Now that we are filling up workshops many weeks in advance, maybe we should send an earlier email as well to confirm everyone's participation and send other general info. Here's an example of a few points from an email sent by a coinstructor for a software carpentry i'll be teaching:
If you are planning to attend, please confirm by replying to this email by DATE. If you won’t be able to attend, please let us know as well so that we can offer your seat to someone on the waiting list. [remind what the workshop is about and its level, so people who are too novice or too advanced might reconsider]
Be sure to complete the pre-workshop survey at URL, ideally by DATE. We use this to calibrate the pace of the workshop and, together with a post-workshop survey, to assess how it went.
Make sure you have the necessary software installed on your laptop; specifically X. Here are the instructions: URL. If you have any trouble, send us an email or come a little early on the morning of DATE. Someone will be there by 08:30 to help with installation issues. We also maintain a list of common issues that occur during installation that you can go through as well: https://github.com/carpentries/workshop-template/wiki/Configuration-Problems-and-Solutions
Please read our Code of Conduct (URL) so that we all are aware of how to treat each other respectfully. We are committed to making sure that the workshop is accessible to everyone. Please tell us if there is anything we should know in advance in order to make the workshop accessible for you
Practical guide on how to handle sign-ups, reconfirmation, BOR assignment, import back to Indico.
Should be updated together with #64 and #65 https://coderefinery.github.io/manuals/indico-workshop-management/ needs updates.
Instead of Google Doc. This way we can edit and learn Markdown at the same time.
... unless you are sure that the room is full.
In Oslo we had many cancellations but the workshop page said that the registration was full and one participant told us that a colleague did not register a week before because it looked full.
We could add a checklist for what should be in the reference guides (aka cheatsheets) for each lesson. For example:
As part of the workflow.
Ie check that all internal links that are mentioned in manuals actually (still) have the page that is linked to.
from EL onboarding session 13.9
.bashrc / .gitconfig files out of the way so you have an environment that looks like othersIdeas:
pickling environment... done
checking consistency... /home/bast/tmp/manuals/exercise-coordinator.md: WARNING: document isn't included in any toctree
/home/bast/tmp/manuals/registration-coordinator.md: WARNING: document isn't included in any toctree
/home/bast/tmp/manuals/workshop-marketing.md: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [100%] zoom-mechanics-old
/home/bast/tmp/manuals/workshop-playbook.md:14: WARNING: 'myst' reference target not found:
/home/bast/tmp/manuals/workshop-playbook.md:16: WARNING: 'myst' reference target not found:
/home/bast/tmp/manuals/workshop-playbook.md:17: WARNING: 'myst' reference target not found:
/home/bast/tmp/manuals/workshop-playbook.md:18: WARNING: 'myst' reference target not found:
/home/bast/tmp/manuals/workshop-playbook.md:20: WARNING: 'myst' reference target not found:
Each lesson should have an instructor guide and presentation notes
As part of this, we could suggest a co-instructor system. If you are presenting the first time, you are thinking too much about the small picture and not about big picture (time considerations). So even two new instructors is better than one.
"staff registration" has been confusing for ELs: https://indico.neic.no/event/xxx/registrations/ - we will change that for future workshops but where is a good place to track that issue? can somebody please create that issue?
from chat
specifically for online workshops we can recommend a setup for participants with single screen, with e.g. workshop page on left, zoom window top right and terminal bottom right. Or something like that. Saw this in https://easybuilders.github.io/easybuild-tutorial/
Co-hosts need to be enabled (on website) before the meeting starts. If options are reconfigured, the meeting may need to be ended and restarted for them to take effect.
Great advice here:
https://www.librarian.net/stax/4965/how-to-help-someone-use-a-computer-by-phil-agre/
Let's link to it and use it.
Good resource to at least link to:
https://foundation.mozilla.org/en/blog/tips-make-your-zoom-gatherings-more-private/
Motivation (discussion on the Carpentries mailing list): https://carpentries.topicbox.com/groups/discuss/Td64229aeb252a027
In short, the motivation is to simplify reuse for those who wish to take parts of our lessons and remix them into material which is CC-BY.
At the team meeting 2019-08-12 we have decided to change the license to CC-BY provided that all contributors to this lesson material agree to this change.
This issue will track the progress of this change.
Some parts of the EL onboarding /manuals material is still written in a way which assumes that teams are in our exercise zoom room. Ie "ask expert helper to drop by", ....
CC-BY Giordano Lipari
(these might already be there but now too lazy to compare, just saving notes from a meeting)
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.