Merge pull request #132 from C2SM/review_MS

Review and corrections to beginner's material

Author: AnnikaLau

beginner/Exercise_2_switch_branches.md

@@ -3,7 +3,7 @@
 ## Objective
 
    * Learn how to work with branches and switch between them using `git switch`.
-   * Note: `git checkout` can be used as an alternative to `git switch`. However, it has different features that have caused confusion among users in the past. So we won't use it here, but show the alternative commands in brackets, as some older Git versions don't have this option yet.
+   > **Note**: `git checkout` can be used as an alternative to `git switch`. However, it has different features that have caused confusion among users in the past. So we won't use it here, but show the alternative commands in brackets, as some older Git versions don't have this option yet.
 
 ## Structure
 
@@ -86,7 +86,7 @@ git branch
 ```
 
 We can easily switch between these branches using the `git switch` command.
-Don't worry -> Git will keep all your work done on that branch.
+Don't worry -> Git will keep all your committed work on that branch.
 
 5. Switch back to *main* branch:
 ```bash

beginner/Exercise_3_restore_merge.md

@@ -53,7 +53,7 @@ We can use `git restore` to get any version of a file along its Git history.
 
 Just run `git restore -s <specific_commit_hash> <your_schedule>`.
 
-**Note**: 
+> **Note**:
 For simplicity, we've used the `-s` option in the `git restore` command. Note that `-s` is a shorthand for `--source`, which you can also use interchangeably. The primary difference lies in the syntax: use `-s <commit_hash>` for a shorter command, or `--source=<commit_hash>` if you prefer a more explicit approach. Both options perform the same function: specifying the source from which to restore. Whether you prefer `-s` for brevity or `--source` for clarity is up to you.
 
 2. Undo "Change poster sessions to talks" by restoring the *schedule_day1.txt* to the commit before the change.
@@ -78,19 +78,14 @@ Each *commit hash* is unique, so you can always go to any version of the tracked
 
 Your output should look similar to:
 ```
-b7bd111 (HEAD -> main) Remove workshop on day1
+b7bd111 (HEAD -> main) Remove workshop on day 1
 f6c3f04 Change talks back to poster sessions
 5889296 Change poster sessions to talks
 464fc92 Add workshop
 e53b1e0 Add coffee break
 f1b23c1 Add poster sessions in the morning
 f636890 Add schedule_day2
 206f724 Add schedule_day1
-1c1e740 Changed poster sessions to talks
-154f0dc Add coffee break
-a98abe7 Add poster sessions in the morning
-ca117ca Add schedule_day2
-b82e094 Add schedule_day1
 ```
 
 
@@ -100,11 +95,11 @@ There are two sections in *schedule_day1.txt*, which we will change on separate
    * *daily_program*
    * *evening_activity*
 
-Note: Try to avoid merge conflicts by not changing the same part of a file in two branches you want to merge (usually the *main* branch and a branch you want to merge into the *main* branch). There are, of course, ways to deal with merge conflicts, and we will learn how to deal with them later in this course, but for now we will try to avoid them. If you follow the descriptions below, you should not run into a merge conflict.
+> **Note**: Try to avoid merge conflicts by not changing the same part of a file in two branches you want to merge (usually the *main* branch and a branch you want to merge into the *main* branch). There are, of course, ways to deal with merge conflicts, and we will learn how to deal with them later in this course, but for now we will try to avoid them. If you follow the descriptions below, you should not run into a merge conflict.
 
 1. Switch to a new branch for the evening activity.
 
-2. Open the schedules add evening activities.
+2. Open the schedules and add evening activities.
 
 3. Add and commit the changes.
 
@@ -156,16 +151,16 @@ For this merge, Git performs what is called a **3-way merge**, because the path
 Your Git log looks like the following:
 ```
 c0d0459 (HEAD -> main) Merge daily_program
-b1be3b4 (daily_program) Add talk
-4d93eac (evening_activity) Add evening activity
-dd09add No more workshop
-cc345c6 Revert poster sessions
-ebc8d06 Change poster sessions to talks
-56c65e8 Add workshops
-e0ced97 Add coffee break
-90b9b5e Add poster sessions in the morning
-2a00ec0 Add schedule_day2
-20be4d2 Add schedule_day1
+b1be3b4 (daily_program) Add talks
+4d93eac Add evening activities
+b7bd111 Remove workshop on day 1
+f6c3f04 Change talks back to poster sessions
+5889296 Change poster sessions to talks
+464fc92 Add workshop
+e53b1e0 Add coffee break
+f1b23c1 Add poster sessions in the morning
+f636890 Add schedule_day2
+206f724 Add schedule_day1
 ```
 
 13. Again, make sure to delete the branch you just merged.

beginner/Exercise_4_workflow_gitignore.md

@@ -59,7 +59,7 @@ Remember, the *.gitignore* file should be committed into your repository, so it
 
 Log files are typically generated for debugging and monitoring purposes but are not meant to be part of the Git repository. Since they change frequently and can grow large, they are usually added to the *.gitignore* file to keep the repository clean and prevent unnecessary clutter.
 
-5. Add a wildcart to the *.gitignore* file to exclude all log files.
+5. Add a wildcard to the *.gitignore* file to exclude all log files.
 
 6. Check the status of *git-course* repository. Does the log file still show up?
 
@@ -81,7 +81,7 @@ init_repo_empty_schedule
 7. Add and commit the changes.
 We continue to plan.
 8. Add a lunch break, another talk and a second poster session to the schedule and commit your changes.
-9. Check if all of your changes are really tracked by Git by checking the status und the history.
+9. Check if all of your changes are really tracked by Git by checking the status and the history.
 
 If you don't have any untracked changes in your repository, proceed to the next part of this exercise.
 
@@ -106,7 +106,7 @@ Thanks to Git we can easily restore files, even if they are deleted.
 1. Create a new branch.
 2. We are not sure yet if Professor X will accept the talk in the morning, therefore change the talk to a workhop on this branch as an alternative schedule.
 3. Add and commit your changes.
-4. No switch back to branch *main* and create another branch on top of it.
+4. Now switch back to branch *main* and create another branch on top of it.
 
 We want to plan an evening activity but are not sure what it will be. Therefore, we create two branches with different activities.
 
@@ -141,6 +141,7 @@ Decide which one you prefer.
 12. Delete the merge branch.
 
 There is one unused branch left in our repository.
+
 13. We want to keep the repository clean and nice. So please delete the unmerged branch as well.
 
 **Remark:** Since we did not merge the remaining branch, it has to be done differently before. But don't worry, Git will tell you what to do.

beginner/helpers.sh

@@ -35,7 +35,6 @@ get_default_branch_name() {
 
 init_exercise () {
     cd $dir_at_startup
-    mkdir -p ../../beginners_git
     rm -rf ../../beginners_git
     mkdir -p ../../beginners_git
     cd ../../beginners_git
@@ -56,7 +55,7 @@ init_repo_empty_schedule () {
 init_simple_repo () {
     cd $dir_at_startup
     rm -rf ../../beginners_git/conference_planning
-    mkdir ../../beginners_git/conference_planning
+    mkdir -p ../../beginners_git/conference_planning
     cd ../../beginners_git/conference_planning
     git init
 
@@ -140,7 +139,7 @@ init_repo () {
 init_repo_remote () {
     cd $dir_at_startup
     rm -rf ../../beginners_git/conference_planning
-    mkdir ../../beginners_git/conference_planning
+    mkdir -p ../../beginners_git/conference_planning
     cd ../../beginners_git/conference_planning
     git init
 
@@ -219,4 +218,4 @@ commit_to_remote_by_third_party() {
     rm -rf conference_planning_remote_tmp
 
     cd conference_planning
-}
+}