RSE-Sheffield / git-github-zero-to-hero

Training materials for zero to hero training in version control through git, github and gitkraken
https://srse-git-github-zero2hero.netlify.app/
17 stars 10 forks source link

Add Templates and instructions to leverage myDevelopment #102

Closed ns-rse closed 5 months ago

ns-rse commented 7 months ago

In an effort to centralise training the Git, GitHub and GitKraken course now has its own space on myDevelopment.

In light of this it would be useful to add issue templates and align them with the process of having upcoming/scheduled courses added to the site.

Currently control of this is not within RSE team members and is mediated by Norbert Gyenge.

This issue will document the procedure (as it is the first time it will be undertaken) and serve as a basis for the revised template.

Steps

+ [ ] Identify lead and assistant to run the course.
+ [ ] Choose date(s) on which to run the course.
+ [ ] Choose whether course will be in-person (recommended) or on-line.
  + [ ] If in-person [book a room](https://sites.google.com/sheffield.ac.uk/pooledroomdirectory/home).
+ [ ] Contact [Norbert Gyenge](mailto:n.g.gyenge@sheffield.ac.uk) with details, the page description shouldn't need changing.
+ [ ] Schedule emails for those who are registered.

If the course is being run on-line then the stages in the existing template to schedule emails can be used...

### Blackboard Collaborate Session
- Go to [Blackboard Collaborate](https://vle.shef.ac.uk), logging in via MUSE,
- Under `Organisations` open `COM - Research Software Engineering`,
- Select `Create Session` and fill in the details as follows:
  - Session Name: `git & GitHub through GitKraken - from Zero to Hero!`
  - Guest Access: :heavy_check_mark:
  - Make sure that `Guest role` is set to `participant`
  - Set the start and end dates and times suitable for the session, add 30 mins to 1hr extra onto the scheduled end time.
  - Early entry: 15 minutes before start time.
- Click `create`, this will create the session link, make a note of this for the emails.

Scheduled Emails

As we are moving away from using Eventbrite to organise the sessions the ability to schedule emails will change. What this will be is unclear at the time of writing and has been queried. Once details of how to contact those who have registered is available this issue will be updated. The templates under emails/ can still be used but may require slight tweaking.

ns-rse commented 6 months ago

Need to be clearer in our communication whether the course is in-person/remote/hybrid. The first day has worked ok hybrid, but the second day with the Advanced Collaboration exercise works less well.

Its generally preferable to do either in-person or remote rather than attempting hybrid because of the interactive nature of the course.

Thus, emails should be tailored to this and the Issue Templates need to be clear on removing reference to online if the course is in-person and vice-versa.

tdjames1 commented 6 months ago

Thus, emails should be tailored to this and the Issue Templates need to be clear on removing reference to online if the course is in-person and vice-versa.

Is it worth creating _inperson.Rmd and _online.Rmd versions of the email templates, with any common content being included via 'child' documents? https://bookdown.org/yihui/rmarkdown-cookbook/child-document.html

ns-rse commented 6 months ago

Good idea, have written up as a separate issue.

ns-rse commented 5 months ago

106 added templates, closing this issue, if the template needs updating please create a new issue (e.g. #107).