Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Templates and instructions to leverage myDevelopment #102

Closed
ns-rse opened this issue Jan 9, 2024 · 4 comments
Closed

Add Templates and instructions to leverage myDevelopment #102

ns-rse opened this issue Jan 9, 2024 · 4 comments
Assignees
Labels
enhancement New feature or request session-setup

Comments

@ns-rse
Copy link
Collaborator

ns-rse commented Jan 9, 2024

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:[email protected]) 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 ns-rse added enhancement New feature or request session-setup labels Jan 9, 2024
@ns-rse ns-rse self-assigned this Jan 9, 2024
@ns-rse ns-rse changed the title Update Templates and instructions to leverage myDevelopment Add Templates and instructions to leverage myDevelopment Jan 15, 2024
@ns-rse
Copy link
Collaborator Author

ns-rse commented Feb 8, 2024

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.

ns-rse added a commit that referenced this issue Feb 21, 2024
Addresses #102 but will likely need a few revisions, couldn't find a method of previewing these templates but have
validated the YAML.
ns-rse added a commit that referenced this issue Feb 21, 2024
Addresses #102 but will likely need a few revisions, couldn't find a method of previewing these templates but have
validated the YAML.
ns-rse added a commit that referenced this issue Feb 21, 2024
Addresses #102 but will likely need a few revisions. I've combined the session setup and email scheduling into a single
issue here. Couldn't find a method of previewing these templates but have validated the YAML and can check the schema is
valid on the branch on GitHub before requesting a merge.
@tdjames1
Copy link
Contributor

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
Copy link
Collaborator Author

ns-rse commented Feb 21, 2024

Good idea, have written up as a separate issue.

@ns-rse
Copy link
Collaborator Author

ns-rse commented Mar 12, 2024

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

@ns-rse ns-rse closed this as completed Mar 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request session-setup
Projects
None yet
Development

No branches or pull requests

2 participants