update GitHub repo overview section to newer printscreen

UCSB-Library-Research-Data-Services · Jun 27, 2024 · d6bd909 · d6bd909
1 parent d15bc7a
commit d6bd909
Show file tree

Hide file tree

Showing 13 changed files with 30 additions and 19 deletions.
diff --git a/_quarto.yml b/_quarto.yml
@@ -39,7 +39,7 @@ website:
               - href: git_cli.qmd
                 text: "Using git at the command line"
               - href: git_conflicts.qmd
-                text: "Managing version conflicts"
+                text: "Managing conflicts"
               - href: git_further_readings.qmd
                 text: "Git and GitHub further readings"
           - section: "Collaborative strategies"

diff --git a/git_conflicts.qmd b/git_conflicts.qmd
@@ -129,5 +129,5 @@ Don't forget to pull and push to synchronize your local changes with GitHub.
 
 If you now look at the history, you can see how git has tracked the conflict resolution. We will talk about branches later on, but spoiler alert it looks very much how you would merge a branch back to the main branch.
 
-![](img/git_conflict-09_post_merge_history.png){fig-align="center" width=60%}
+![](img/git_conflict-09_post_merge_history.png){fig-align="center" width=80%}
 
diff --git a/github_intro.qmd b/github_intro.qmd
@@ -85,28 +85,40 @@ We will talk more about GitHub Organizations later. In a nutshell, organizations
 
 ### Let's look at a repository on GitHub
 
-This screen shows the copy of a repository stored on GitHub,
-with its <span style="color:red">list of files</span>, <span style="color:green">when the files and directories were last modified</span>, 
-and <span style="color:blue">some information on who made the most recent changes.</span>  
+The screenshot below shows the landing page of a repository on GitHub. We would like to highlight different important part of this view:
 
-![](img/ss3sim-github_colored.png){fig-align="center" width=80%}
+- Directly under the navigation bar (top-left) you will find the name of the repository (orange)
+- Above the files listing, there is information about the latest commit to this repository (blue)
+- On the left, you will have the files and folder names (red)
+- In the middle, the last commit message on this file (or file contained in a folder) (purple)
+- On the right, the time stamps of the latest commit (green)
 
-If we drill into the 
-"<span style="color:orange">commits</span>" for the repository, we can see the history of changes made to all of 
-the files.  Looks like `kellijohnson` and `seananderson` were fixing things in
-June and July:
+![](img/github-repo.png){fig-align="center" width=80%}
 
-![](img/ss3sim-commits_colored.png){fig-align="center" width=80%}
+Below the file listing, there will be a rendering of the README.md file, one more reason to make sure to add one :) 
+Looking into more details at the information provided about the last commit, we can see that we know:
 
-And finally, if we drill into the changes made on June 13, we can see exactly what
-was changed in each file:
+- Which user did this last commit (brunj7) and the associated commit message
+- The the 7 first digit of unique identifier ([SHA](https://en.wikipedia.org/wiki/Secure_Hash_Algorithms)) of this commit
+- When this last commit was made (3 months ago)
+= The total number of commits on this branch (43 Commits)
 
-![](img/ss3sim-diff.png){fig-align="center" width=80%}
+![](img/github-repo_last-comit.png){fig-align="center" width=80%}
 
-Tracking these changes, and seeing how they relate to released versions of software and files
+This total number of commits is actually a hyperlink that lets you access the full history of the main branch by clicking on it.
+
+![](img/github-repo_history.png){fig-align="center" width=80%}
+
+
+We can keep drilling and look at a specific commit by clicking on the hash number. For example if we look at the first commit at the top (20bc390), we can see the exact changes that have been made:
+
+
+![](img/github-repo_commit-view.png){fig-align="center" width=80%}
+
+Tracking these changes, and seeing how they relate to scripts and files
 is exactly what Git and GitHub are good for. We will show how they can really 
-be effective for tracking versions of scientific code, figures, and manuscripts
-to accomplish a reproducible workflow.
+be effective for tracking versions of scientific code, figures, and other text 
+files such as manuscripts to develop a reproducible workflow.
 
 
 ## Recap

diff --git a/img/github-repo.png b/img/github-repo.png
diff --git a/img/github-repo_commit-view.png b/img/github-repo_commit-view.png
diff --git a/img/github-repo_history.png b/img/github-repo_history.png
diff --git a/img/github-repo_last-comit.png b/img/github-repo_last-comit.png
diff --git a/img/ss3sim-commits.png b/img/ss3sim-commits.png
diff --git a/img/ss3sim-commits_colored.png b/img/ss3sim-commits_colored.png
diff --git a/img/ss3sim-diff.png b/img/ss3sim-diff.png
diff --git a/img/ss3sim-github.png b/img/ss3sim-github.png
diff --git a/img/ss3sim-github_colored.png b/img/ss3sim-github_colored.png
diff --git a/index.qmd b/index.qmd
@@ -16,7 +16,7 @@ citation:
 categories: [data-science, collaboration, reproducible-research]
 ---
 
-The “Designing a Reproducible and Collaborative Research Lab” program, currently piloted by the Research & Data Services (RDS) department at the [UCSB Library](https://www.library.ucsb.edu/), combines group workshops, own-pace learning, and personalized coaching sessions for Faculty and their Team son the following topics.
+The ***Designing a Reproducible and Collaborative Research Lab*** program, currently piloted by the Research & Data Services (RDS) department at the [UCSB Library](https://www.library.ucsb.edu/), combines group workshops, own-pace learning, and personalized coaching sessions for Faculty and their Team son the following topics.
 
 ### Topics
 
@@ -50,5 +50,4 @@ The “Designing a Reproducible and Collaborative Research Lab” program, curre
 
 If you are interested in this program, please see the [about](about.qmd) page to connect with us.
 
-
 ![](img/rds_hex.png){fig-align="center" width="50%"}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -129,5 +129,5 @@ Don't forget to pull and push to synchronize your local changes with GitHub.

		If you now look at the history, you can see how git has tracked the conflict resolution. We will talk about branches later on, but spoiler alert it looks very much how you would merge a branch back to the main branch.

		![](img/git_conflict-09_post_merge_history.png){fig-align="center" width=60%}
		![](img/git_conflict-09_post_merge_history.png){fig-align="center" width=80%}