#79 Add in git and GitHub to the glossary

* Add in git and GitHub to the glossary. Add in an instructor note in episode 1 to ensure the glossary and difference between Git and GitHub are mentioned. * Update learners/reference.md Co-authored-by: Emma Hogan <[email protected]> * Update learners/reference.md Co-authored-by: Emma Hogan <[email protected]> * Address review comments - Version Control System (VCS), remove subversion comment/comparison from Git section * Clarify link between Git and GitHub in GitHub glossary entry --------- Co-authored-by: Emma Hogan <[email protected]>
MetOffice · Dec 18, 2024 · feb2f88 · feb2f88
1 parent 52de13d
commit feb2f88
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 5 deletions.
diff --git a/episodes/01-basics.md b/episodes/01-basics.md
@@ -62,7 +62,25 @@ metadata make up a [repository](../learners/reference.md#repository).
 Repositories can be kept in sync across different computers, facilitating
 collaboration among different people.
 
-## Distributed Version Control
+## Terminology
+
+This workshop may contain language that is new to you.
+The [Glossary](../learners/reference.md#glossary) section
+outlines key Git & GitHub terminology for your reference.
+
+::: instructor
+
+### Explain Key Terminology
+
+Take this opportunity to show the learners where the glossary can be found.
+Explain the difference between Git & GitHub using the glossary!
+Or if there is time to spare, the first challenge on this page
+gets the learners to use the glossary to explain the difference
+to a partner or write it down in their own words.
+
+:::
+
+### Distributed Version Control
 
 Git is an example of a
 [distributed version control](../learners/reference.md#glossary) system.
@@ -97,7 +115,7 @@ flowchart TD
     r4 -->|checkout| id4 -.->|commit| r4
 ```
 
-### Centralised (FCM)
+#### Centralised (FCM)
 
 FCM and SVN are examples of
 [centralised version control](../learners/reference.md#glossary) systems.
@@ -167,6 +185,16 @@ fcm ...
 
 :::::::::::::::::::::::::::::::::::::::  challenge
 
+Use the [Glossary](../learners/reference.md#glossary) to describe
+the difference between Git & GitHub in your own words.
+
+Share your description with other learners if you
+are comfortable doing so.
+
+::::::::::::::::::::::::::::::::::::::::::::::::::
+
+:::::::::::::::::::::::::::::::::::::::  challenge
+
 ## Paper Writing
 
 - Imagine you drafted an excellent paragraph for a paper you are writing, but later ruin

diff --git a/learners/reference.md b/learners/reference.md
@@ -17,6 +17,11 @@ title: 'Git Cheatsheets for Quick Reference'
 :   A git branch is a pointer to a commit. Branches are used to develop
 changes in parallel, isolated from each other.
 
+[Centralised Version Control System]{#cvc}
+:   In a Centralised Version Control System such as Subversion
+a single, centralised server contains the main copy of a repository.
+Working on code requires internet access to the centralised server.
+
 [changeset]{#changeset}
 :   A group of changes to one or more files that are or will be added
 to a single [commit](#commit) in a [version control](#version-control)
@@ -35,6 +40,25 @@ that is incompatible with changes made by other users.
 Helping users [resolve](#resolve) conflicts
 is one of version control's major tasks.
 
+[Distributed Version Control System]{#dvc}
+:   In a Distributed Version Control System such as [Git](#git)
+each collaborator has a copy of the entire repository
+and its history.
+Working on code does not require internet access and there
+are multiple backups of the entire repository.
+
+[Git]{#git}
+:   [Git](https://git-scm.com/) is a free and open source
+Version Control System (VCS) capable of tracking the history
+of our files and recover previous versions.
+Git is an example of a [Distributed Version Control System](#dvc).
+
+[GitHub]{#github}
+:   [GitHub](https://docs.github.com/en/get-started/start-your-journey/about-github-and-git)
+is a cloud-based platform where you can store, share,
+and work together with others to write code.
+GitHub is built upon [Git](#git).
+
 [HTTP]{#http}
 :   The Hypertext Transfer [Protocol](#protocol) used for sharing web pages and other data
 on the World Wide Web.
@@ -76,10 +100,8 @@ small.
 [timestamp]{#timestamp}
 :   A record of when a particular event occurred.
 
-[version control]{#version-control}
+[Version Control System (VCS)]{#version-control}
 :   A tool for managing changes to a set of files.
 Each set of changes creates a new [commit](#commit) of the files;
 the version control system allows users to recover old commits reliably,
 and helps manage conflicting changes made by different users.
-
-