markdown source builds

Auto-generated via `{sandpaper}` Source : f2fc2f6 Branch : main Author : Dimitrios Theodorakis <[email protected]> Time : 2025-01-20 10:45:14 +0000 Message : MetOffice#116 Update the instructor notes
astroDimitrios · Jan 20, 2025 · 0725004 · 0725004
1 parent 471b2f5
commit 0725004
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 23 deletions.
diff --git a/04-changes.md b/04-changes.md
@@ -54,7 +54,7 @@ $ ls
 ```
 
 ```output
-forecast.md
+forecast.md README.md
 ```
 
 `forecast.md` contains three lines, which we can see by running:
@@ -80,9 +80,6 @@ $ git status
 
 ```output
 On branch forecast
-
-No commits yet
-
 Untracked files:
    (use "git add <file>..." to include in what will be committed)
 
@@ -107,9 +104,6 @@ $ git status
 
 ```output
 On branch forecast
-
-No commits yet
-
 Changes to be committed:
   (use "git rm --cached <file>..." to unstage)
 

diff --git a/05-history.md b/05-history.md
@@ -46,6 +46,9 @@ when it was created,
 and the log message Git was given when the commit was created.
 The output above only shows the latest commit in the log for brevity,
 you should see all your commits!
+Your log output may be different from what's shown above
+depending on whether you completed the challenges
+in earlier episodes.
 
 ::: spoiler
 

diff --git a/instructor-notes.md b/instructor-notes.md
@@ -19,21 +19,16 @@ lets you focus on the more interesting/innovative aspects of your project.
 
 ## Overall
 
-Version control might be the most important topic we teach, but Git is
-definitely the most complicated tool.  However, GitHub presently dominates the
-open software repository landscape, so the time and effort required to teach
-fundamental Git is justified and worthwhile.
-
-Because of this complexity, we don't teach novice learners about many
-interesting topics, such as hashes, and commit objects.
-
-Instead we try to convince them that version control is useful for
+We try to convince learners that version control is useful for
 working in teams or not, because it is
 
 - a better way to "undo" changes,
 - a better way to collaborate than mailing files back and forth, and
 - a better way to share your code and other work with the world.
 
+We teach version control using Git and GitHub because
+they are the most widelt used version control tools.
+
 ## Teaching Notes
 
 - You can "split" your shell so that recent commands remain in view using [this](https://github.com/rgaiacs/swc-shell-split-window) script.
@@ -83,6 +78,32 @@ working in teams or not, because it is
   - [Code School][code-school] has a free interactive course, [Try Git][try-git].
   - for instructors, [the Git parable][git-parable] is useful background reading
 
+## Introduction
+
+At the start of the lesson take some time to:
+
+While you are waiting for everyone post the pre-lesson survey form in the chat.
+If they haven't done this they must now.
+
+- Introduce the instructors and the helpers
+- Outline a rough schedule (there is a rough schedule in the instructor view setup page)
+  Or simply state that the morning focuses on Git and the afternoon on GitHub
+- Remember to take regular breaks
+- What are the outcomes of the lesson? They are on the Setup page!
+- How to navigate the material.
+  Where are the git and fcm to git cheatsheets?
+  Learners can do the challenges or the read the Discussion section if they are ahead.
+- We understand a large amount of the information in this course will likely be new to most of you,
+  so we encourage you to ask questions at any time.
+  Remember, there is no such thing as a stupid question!
+  (remember to let learners know how you want them to ask Qs
+  in-person learners can raise their hands or use green/red sticky notes,
+  online learners can raise their hand)
+- How to get help with anything related to Git and GitHub after the training (surgeries and support mailbox)
+- Mention about the feedback form and that any feedback will be used to improve the training
+- Ensure the material can be read by learners in the room (to change the font size in firefox use View --> Zoom --> Zoom In or <ctrl><+>)
+- Ensure learners can hear you well
+
 ## [Automated Version Control](../episodes/01-basics.md)
 
 - Ask, "Who uses 'undo' in their editor?" All say "Me". 'Undo' is the simplest
@@ -102,10 +123,10 @@ working in teams or not, because it is
 
 Why are we moving to Git and GitHub?
 
-- FCM/SVN becoming unmaintainable
-- Git/GitHub provide better security (MFA)
-- GitHub has more useful features for collaboration than trac
-- Easier to collaborate with partners outside the Met Office with GitHub
+- Business continuity: Using Git and GitHub mitigates risks of supporting (via single points of expertise at the MO) the ongoing need for provisioning and commissioning infrastructure to support the legacy Subversion and Trac
+- Productivity and skills: Git and GitHub enables improved, modern working practices via task management tools, in-line code review, and automated testing
+- Security: GitHub provides Multi-Factor Authentication (MFA) and corporate Single Sign-On (SSO)
+- Collaboration: GitHub facilitates collaboration and code sharing
 
 ## [Setting Up Git](../episodes/02-setup.md)
 
@@ -221,6 +242,12 @@ Git & GitHub Working Practices training.
 You can also mention that it is possible to edit files via the GitHub
 interface but we won't be doing that today.
 
+## [End](../episodes/End.md)
+
+Post a link to the post-lesson survey.
+Show them this page so they see the options for more learning.
+Mention the Git & GitHub Working Practices lesson.
+
 ## [Collaborating](../episodes/08-collab.md)
 
 NOT IN THE MET OFFICE VERSION

diff --git a/md5sum.txt b/md5sum.txt
@@ -7,8 +7,8 @@
 "episodes/02-setup.md" "3ba631342db50f2ce7a1090a908b1a75" "site/built/02-setup.md" "2024-12-19"
 "episodes/03-create.md" "80501395036c8964535186d8fc5750a7" "site/built/03-create.md" "2024-12-19"
 "episodes/09-branches.md" "cf749f93883ff6e976d3579ef5dfe9d1" "site/built/09-branches.md" "2025-01-15"
-"episodes/04-changes.md" "ccacb3193dbc9778103fd746a3a15881" "site/built/04-changes.md" "2024-12-19"
-"episodes/05-history.md" "5fd75835cea9c764d9ccdae1d58fb852" "site/built/05-history.md" "2024-12-19"
+"episodes/04-changes.md" "514e983a950c84ac7fd1d20003c817b8" "site/built/04-changes.md" "2025-01-20"
+"episodes/05-history.md" "99a77a9c85de2d47d52d6ef1d1a3367f" "site/built/05-history.md" "2025-01-20"
 "episodes/06-reverting-changes.md" "c471049c81312a392cfd8cd953dbe1cc" "site/built/06-reverting-changes.md" "2024-12-18"
 "episodes/06-ignore.md" "c00ad3f65358df8d9d55a715fdffc8f3" "site/built/06-ignore.md" "2024-12-19"
 "episodes/Break.md" "eb9b99e3008292caed78ca6252c653c0" "site/built/Break.md" "2024-12-19"
@@ -23,7 +23,7 @@
 "episodes/12-citation.md" "c74aa1d0c8f60e69bdb7827560f2ac53" "site/built/12-citation.md" "2024-12-03"
 "episodes/13-hosting.md" "c390f6e5ab0017576241ff881a26604c" "site/built/13-hosting.md" "2024-12-03"
 "episodes/14-supplemental-rstudio.md" "90970ec2287448cddbf421140d501834" "site/built/14-supplemental-rstudio.md" "2024-12-19"
-"instructors/instructor-notes.md" "dfe2355d48491763fe16b6b1d5dc2caf" "site/built/instructor-notes.md" "2024-12-19"
+"instructors/instructor-notes.md" "439ca83a248dae6f0e2590b6df16e10f" "site/built/instructor-notes.md" "2025-01-20"
 "learners/discuss.md" "998f06799541bd3b21247a709324a8ab" "site/built/discuss.md" "2024-12-19"
 "learners/fcm-git_cheat_sheet.md" "29ccb51a92f941d673f7a46d5c97b914" "site/built/fcm-git_cheat_sheet.md" "2024-12-12"
 "learners/reference.md" "4f100436a2f16b82e73515911e488a40" "site/built/reference.md" "2024-12-19"