Render bookdown

fhdsl · Jan 9, 2024 · c48b236 · c48b236
1 parent e56ec15
commit c48b236
Show file tree

Hide file tree

Showing 12 changed files with 16 additions and 11 deletions.
diff --git a/docs/01-workshop.md b/docs/01-workshop.md
@@ -1,4 +1,5 @@
 
+
 # Workshop Notes
 
 ## Review Intro to Git material
@@ -337,7 +338,7 @@ To create a new branch on your remote, you can use the GitHub website:
 
 ![](images/git_branch.png)
 
-The branch `clo2_developmenet` is created on the remote, but it hasn't been updated locally. We run `git pull` locally to update it and switch to that branch via `git checkout`.
+The branch `clo2_development` is created on the remote, but it hasn't been updated locally. We run `git pull` locally to update it and switch to that branch via `git checkout`.
 
 ```         
 % git pull
@@ -363,7 +364,10 @@ After a variable number of commits and pushes, your remote branch is a different
 
 ### Pull Requests
 
-A **pull request** is a way to propose changes from a branch before it is merged back into the main repository. It is just like `git merge`, but it requires more documentation and confirmation. For instance, a collaborator can create their own work on a branch, and then create a pull request to have that new branch's feature to be integrated back to the main branch. The owner of the repository review the proposed changes before accepting the pull request.
+A **pull request** is a way to propose changes from a branch before it is merged back into the main repository. It is just like `git merge`, but it requires more documentation and confirmation. For instance, a collaborator can create their own work on a branch, and then create a pull request to have that new branch's feature to be integrated back to the main branch. The owner of the repository sometimes review the proposed changes before accepting the pull request.
+
+
+![](resources/images/01-workshop_files/figure-docx//1IJ_uFxJud7OdIAr6p8ZOzvYs-SGDqa7g4cUHtUld03I_g1014c75158f_0_751.png){width=100%}
 
 When you have pushed changes to the branch, you will see an option to *"Compare & pull request"*. Click on it.
 
@@ -405,7 +409,7 @@ Some advice for reviewers responding to a pull request:
 
 -   Does the code stick to the style and conventions of this project?
 
-More advice on code review can be found here for [pull request authors](https://jhudatascience.org/Adv_Reproducibility_in_Cancer_Informatics/engaging-in-code-review—as-an-author.html), and [pull request reviewers](https://jhudatascience.org/Adv_Reproducibility_in_Cancer_Informatics/engaging-in-code-review—as-a-reviewer.html).
+More advice on code review can be found here for [pull request authors](https://jhudatascience.org/Adv_Reproducibility_in_Cancer_Informatics/engaging-in-code-review---as-an-author.html), and [pull request reviewers](https://jhudatascience.org/Adv_Reproducibility_in_Cancer_Informatics/engaging-in-code-review---as-a-reviewer.html).
 
 ## Appendix: Local and remote as branches
 

diff --git a/docs/About.md b/docs/About.md
@@ -51,7 +51,7 @@ These credits are based on our [course contributors table guidelines](https://ww
 ##  collate  en_US.UTF-8                 
 ##  ctype    en_US.UTF-8                 
 ##  tz       Etc/UTC                     
-##  date     2023-12-20                  
+##  date     2024-01-09                  
 ## 
 ## ─ Packages ───────────────────────────────────────────────────────────────────
 ##  package     * version date       lib source                            

diff --git a/docs/Collaborative-Git-and-GitHub.docx b/docs/Collaborative-Git-and-GitHub.docx
diff --git a/docs/about-the-authors.html b/docs/about-the-authors.html
@@ -287,7 +287,7 @@ <h1>About the Authors</h1>
 ##  collate  en_US.UTF-8                 
 ##  ctype    en_US.UTF-8                 
 ##  tz       Etc/UTC                     
-##  date     2023-12-20                  
+##  date     2024-01-09                  
 ## 
 ## ─ Packages ───────────────────────────────────────────────────────────────────
 ##  package     * version date       lib source                            

diff --git a/docs/images/git_branch.png b/docs/images/git_branch.png
diff --git a/docs/index.html b/docs/index.html
@@ -147,7 +147,7 @@ <h1>
 </div>
 <div id="header">
 <h1 class="title">Collaborative Git and GitHub</h1>
-<p class="date"><em>December, 2023</em></p>
+<p class="date"><em>January, 2024</em></p>
 </div>
 <div id="about-this-course" class="section level1 unnumbered">
 <h1>About this Course</h1>

diff --git a/docs/index.md b/docs/index.md
@@ -1,6 +1,6 @@
 ---
 title: "Collaborative Git and GitHub"
-date: "December, 2023"
+date: "January, 2024"
 site: bookdown::bookdown_site
 documentclass: book
 bibliography: [book.bib]

diff --git a/...figure-html/1IJ_uFxJud7OdIAr6p8ZOzvYs-SGDqa7g4cUHtUld03I_g1014c75158f_0_751.png b/...figure-html/1IJ_uFxJud7OdIAr6p8ZOzvYs-SGDqa7g4cUHtUld03I_g1014c75158f_0_751.png
diff --git a/.../figure-html/1YmwKdIy9BeQ3EShgZhvtb3MgR8P6iDX4DfFD65W_gdQ_gcc4fbee202_0_141.png b/.../figure-html/1YmwKdIy9BeQ3EShgZhvtb3MgR8P6iDX4DfFD65W_gdQ_gcc4fbee202_0_141.png
diff --git a/docs/resources/images/02-chapter_of_course_files/figure-html/unnamed-chunk-4-1.png b/docs/resources/images/02-chapter_of_course_files/figure-html/unnamed-chunk-4-1.png
diff --git a/docs/search_index.json b/docs/search_index.json
diff --git a/docs/workshop-notes.html b/docs/workshop-notes.html
@@ -386,7 +386,7 @@ <h3><span class="header-section-number">1.6.1</span> Connect to course GitHub re
 <h3><span class="header-section-number">1.6.2</span> Branching with remotes</h3>
 <p>To create a new branch on your remote, you can use the GitHub website:</p>
 <p><img src="images/git_branch.png" /></p>
-<p>The branch <code>clo2_developmenet</code> is created on the remote, but it hasn’t been updated locally. We run <code>git pull</code> locally to update it and switch to that branch via <code>git checkout</code>.</p>
+<p>The branch <code>clo2_development</code> is created on the remote, but it hasn’t been updated locally. We run <code>git pull</code> locally to update it and switch to that branch via <code>git checkout</code>.</p>
 <pre><code>% git pull
 From https://github.com/fhdsl/S2_Collaborative_Git_GitHub_Student_Practice
  * [new branch]      clo2_development -&gt; origin/clo2_development
@@ -404,7 +404,8 @@ <h3><span class="header-section-number">1.6.2</span> Branching with remotes</h3>
 </div>
 <div id="pull-requests-1" class="section level3" number="1.6.3">
 <h3><span class="header-section-number">1.6.3</span> Pull Requests</h3>
-<p>A <strong>pull request</strong> is a way to propose changes from a branch before it is merged back into the main repository. It is just like <code>git merge</code>, but it requires more documentation and confirmation. For instance, a collaborator can create their own work on a branch, and then create a pull request to have that new branch’s feature to be integrated back to the main branch. The owner of the repository review the proposed changes before accepting the pull request.</p>
+<p>A <strong>pull request</strong> is a way to propose changes from a branch before it is merged back into the main repository. It is just like <code>git merge</code>, but it requires more documentation and confirmation. For instance, a collaborator can create their own work on a branch, and then create a pull request to have that new branch’s feature to be integrated back to the main branch. The owner of the repository sometimes review the proposed changes before accepting the pull request.</p>
+<p><img src="resources/images/01-workshop_files/figure-html/1IJ_uFxJud7OdIAr6p8ZOzvYs-SGDqa7g4cUHtUld03I_g1014c75158f_0_751.png" title="After a variable number of commits, your branch, called a-new-branch is a different version of the original code base that may have a nifty improvement to it. But our main goal is to add that nifty improvement to the main branch. To start this process of bringing in new changes to the main curated repository, we will create a pull request. A pull request will show us the difference between main and a-new-branch so you scrutinize this feature before adding it to the main branch." alt="After a variable number of commits, your branch, called a-new-branch is a different version of the original code base that may have a nifty improvement to it. But our main goal is to add that nifty improvement to the main branch. To start this process of bringing in new changes to the main curated repository, we will create a pull request. A pull request will show us the difference between main and a-new-branch so you scrutinize this feature before adding it to the main branch." width="100%" /></p>
 <p>When you have pushed changes to the branch, you will see an option to <em>“Compare &amp; pull request”</em>. Click on it.</p>
 <p><img src="images/git_PR1.png" /></p>
 <p>You will see that you are trying to merge <code>clo2_development</code> into <code>main</code> on the remote. It also requires you to write a description of what you did on your branch.</p>
@@ -433,7 +434,7 @@ <h3><span class="header-section-number">1.6.5</span> Code reviews during a pull
 <li><p>Is the code efficient with computational resources?</p></li>
 <li><p>Does the code stick to the style and conventions of this project?</p></li>
 </ul>
-<p>More advice on code review can be found here for <a href="https://jhudatascience.org/Adv_Reproducibility_in_Cancer_Informatics/engaging-in-code-review—as-an-author.html">pull request authors</a>, and <a href="https://jhudatascience.org/Adv_Reproducibility_in_Cancer_Informatics/engaging-in-code-review—as-a-reviewer.html">pull request reviewers</a>.</p>
+<p>More advice on code review can be found here for <a href="https://jhudatascience.org/Adv_Reproducibility_in_Cancer_Informatics/engaging-in-code-review---as-an-author.html">pull request authors</a>, and <a href="https://jhudatascience.org/Adv_Reproducibility_in_Cancer_Informatics/engaging-in-code-review---as-a-reviewer.html">pull request reviewers</a>.</p>
 </div>
 </div>
 <div id="appendix-local-and-remote-as-branches" class="section level2" number="1.7">