Skip to content
David Wilby edited this page Mar 10, 2022 · 13 revisions

Welcome to the git-github-zero-to-hero wiki! This wiki is used for capturing notes and tips for the delivery of this course.

Instructor Tips

Technical 💻

Screen layout

  • Small screen teaching, share screen with chrome window and gtikraken.
  • Large screen Blackboard collaborate, ensuring I can see emoji status updates, on one window and course materials on another.

GitKraken

  • Command Palette: When creating new files, ensure you leave the path up long enough. Request feedback.

  • Before beginning working on issue, ensure all team members have found their issue and are looking at it.

  • Issue with accepting (finding) GitHub invitations: https://github.community/t/where-do-i-see-all-incoming-invitations-collaborator/661/4.

  • Issues with GitKraken on UBUNTU: installation issue: Solution add note to setup instructions about testing UBUNTU especially and getting in touch if they have issues before course. Appearance issue (not sure what this is?)

Blackboard Collaborate

  • As a moderator/instructor, join the session through https://vle.shef.ac.uk/ > Organisations > Research Software Engineering > find the day's session and join.
  • When asking for yes/no responses on recording the session, use a poll to more easily see who a response is needed from.
  • Use emoji responses (or chat) for assessing whether participants are following. Use raised hands for critical problems that might need assistance.

Delivery Notes 🧑‍🏫

00. Introduction to Version Control

  • stress that git is a piece of software on your computer; GitHub is a website/platform
  • Stop for questions periodically - after git & GitHub, before GitKraken client
  • Licenses
    • Code and other types of content (e.g. photos) have different sorts of license (e.g. CC-BY)
  • Might be worth noting that "repositories" are a git concept, as well as the way that they are presented on GitHub.

01. Getting started with git and GitHub

  • Before this section, and before the break, check that everyone is set up and has their SSH key (or whatever) authentication set up.

02. Websites with GitHub Pages

  • Explain why markdown is useful outside of GitHub pages?
  • Explain GitHub pages source location, why you would choose / (root) vs docs/ for instance.
  • Sometimes it can be slow to build everyone's webpages - just allow time here.

03. Cloning and Collaborating with GitKraken Client

04. Advanced Collaboration with GitHub

  • Make sure that everyone is actually going to be present until the end of the session, if people need to leave, that's fine, they can watch.
  • When the team members start work on their issues, whilst only one can be demonstrated at a time, remind everyone to follow their particular set of instructions in their issue.

FAQs