Merge pull request #3 from NETWAYS/feature/update-global-style

Update global style and bump to showoff 0.9.16

Author: Michael Friedrich

Dockerfile

@@ -33,6 +33,6 @@ RUN cd $HOME \
   && tar vxf wkhtmltox-0.12.3_linux-generic-amd64.tar.xz \
   && cp wkhtmltox/bin/wk* /usr/local/bin/
 
-RUN gem install showoff --version=0.9.11.1
+RUN gem install showoff --version=0.19.6
 
 CMD "/bin/bash"

day1/01_Introduction/03_Basics.md

@@ -16,7 +16,6 @@
 !SLIDE smbullets noprint
 # Snapshots and Differences
 
-* Information as a list of file-based changes
 * File changes and deltas over time
   * Git Commit, take snapshot, store reference to that snapshot
   * Set of snapshots of a mini-filesystem
@@ -27,7 +26,6 @@
 !SLIDE smbullets printonly
 # Snapshots and Differences
 
-* Information as a list of file-based changes
 * File changes and deltas over time
   * Git Commit, take snapshot, store reference to that snapshot
   * Set of snapshots of a mini-filesystem

day1/03_Basics/03_Changes.md

@@ -1,16 +1,10 @@
 !SLIDE smbullets
-# Work on current changes
+# Add current changes
 
 * `git add`
   * Add (modified) file(s) from the working directory into the staging index.
 * `git mv`
   * Rename file(s) tracked by Git.
-* `git reset`
-  * Reset files added to the staging index.
-  * `--soft` keeps the changes (default), `--hard` removes them indefinitely.
-* `git rm`
-  * Remove the file(s) from working tree and Git repository.
-  * Note that file(s) will be visible in Git history, and can be restored from it.
 
 ~~~SECTION:handouts~~~
 
@@ -22,11 +16,30 @@ waiting for the commit.
 `git mv` renames an existing file tracking the change for the commit. If you
 manually move the file, you will need to rm and add it again.
 
+~~~ENDSECTION~~~
+
+
+!SLIDE smbullets
+# Remove changes
+
+* `git reset`
+  * Reset files added to the staging index.
+  * `--soft` keeps the changes (default), `--hard` removes them indefinitely.
+* `git rm`
+  * Remove the file(s) from working tree and Git repository.
+  * Note that file(s) will be visible in Git history, and can be restored from it.
+
+~~~SECTION:handouts~~~
+
+****
+
 `git reset` resets files added to the staging index.
 
 `git rm` removes the file from the working tree and also from the git index.
 
 ~~~ENDSECTION~~~
+
+
 !SLIDE smbullets small
 # Lab ~~~SECTION:MAJOR~~~.~~~SECTION:MINOR~~~: Add a new README.md file
 
@@ -42,8 +55,8 @@ manually move the file, you will need to rm and add it again.
 Best practice is to have a README.md file written in Markdown
 in every project. This gets rendered by GitHub/GitLab in readable HTML.
 
-> During this training we will learn many new things. Keep notes
-> in the README.md file.
+During this training we will learn many new things. Keep notes
+in the `README.md` file.
 
 ~~~SECTION:handouts~~~
 

day1/04_Commits/03_Good_Commits.md

@@ -6,7 +6,7 @@
  * `git add -p` for interactive selection of changes in a file
 * `git commit <file1> <file2>`
 * Enable the verbose mode `-v` to show the differences below the editor
-* `git commit` uses the `EDITOR` environment variable to detect your preferred editor
+ * Write a short summary based on the visible changes
 
 ~~~SECTION:handouts~~~
 

day1/04_Commits/04_History.md

@@ -4,6 +4,19 @@
 * `git log`
   * Show commit history of the current branch.
   * Supports `-10` notation to show a limited number of commits.
+
+~~~SECTION:handouts~~~
+
+****
+
+`git log` shows the commit history of the current branch.
+
+
+~~~ENDSECTION~~~
+
+!SLIDE smbullets
+# Examine the Git history
+
 * `git show`
   * Print commit details.
   * If the commit id is omitted, the last commit is printed.
@@ -17,8 +30,6 @@
 
 ****
 
-`git log` shows the commit history of the current branch.
-
 `git show` will print the last commit details. If you want to print a specific commit id, add
 it afterwards.
 
@@ -27,7 +38,6 @@ also compare specific commits.
 
 ~~~ENDSECTION~~~
 
-
 !SLIDE smbullets
 # Lab ~~~SECTION:MAJOR~~~.~~~SECTION:MINOR~~~: Examine the Commit History
 

day1/04_Commits/05_Amend.md

@@ -28,7 +28,7 @@ problems in collaboration with others.
  * Modify `README.md` and add docs about amend
  * Add `README.md` to the staging index and commit the change
  * Edit `README.md` again and add it to staging
- * Use `git commit --amend README.md` to add the change to the previous commit
+ * Use `git commit --amend README.md` and explain what happens
 * Bonus:
  * Adopt the commit message using `git commit --amend`
 

day1/05_Branching/01_Intro.md

@@ -95,8 +95,7 @@ environment.
  * List the branches with `git branch`
  * Checkout the new branch with `git checkout feature/docs`
 * Bonus:
- * Verify how `git checkout -b feature/docs2` works
- * Explain how it helps here
+ * Explain `git checkout -b feature/docs2`
 
 ~~~SECTION:handouts~~~
 

day1/06_Server/02_Gitlab_Introduction.md

@@ -5,11 +5,10 @@ GitLab is available as self-hosted or cloud based repository management
 system.
 
 * Git repositories
-* User and group management
-* Fine granular permissions (branch protection, etc.)
+* User and group management and fine granular permissions
 * Issue tracking and project management (dashboards, etc.)
 * Merge, review, report
-* Continuous integration (CI)
+* Continuous integration/deployment (CI/CD)
 
 Hosted: https://www.netways.de/managed_hosting/gitlab_ce_hosting/
 

day1/06_Server/04_Connect_Local_Remote.md

@@ -191,10 +191,9 @@ If not set, you can set it explicitly.
  * Add the GitLab project as remote origin
 * Steps
  * Open the project in GitLab and extract the `HTTPS` clone URL
- * Navigate into your local repository
+ * Navigate into your local repository in `$HOME/training`
  * Use `git remote add origin <remoteurl>`
- * Push your local history
- * Use `--set-upstream` (short: `-u`) to enable the local branch tracking the remote repository 
+ * Push your local history with `--set-upstream` (short: `-u`)
 * Bonus
  * Set default push method to `simple`
 
@@ -280,7 +279,7 @@ In order to fix that, add the default push method to your global configuration.
  * Compare the local history to the remote project's history
 * Steps:
  * Click on `History` in the project view and examine the Git commits
- * Run `git log` on your shell and compare them to GitLab
+ * Run `git log` or `tig` on your shell and compare them to GitLab
 
 ~~~SECTION:handouts~~~
 
@@ -305,7 +304,7 @@ In order to fix that, add the default push method to your global configuration.
 ****
 
 * Click on `History` in the project view and examine the Git commits
-* Run `git log` on your shell and compare them to GitLab
+* Run `git log` or `tig` on your shell and compare them to GitLab
 
 
 !SLIDE supplemental solutions
@@ -320,7 +319,7 @@ In order to fix that, add the default push method to your global configuration.
 
 Choose `History` and look at the Git commits, their author, subject and timestamp.
 
-Compare it with the local `git log` entries. 
+Compare it with the local `git log` or `tig` entries. 
 
 
 

day1/07_Collaboration/02_Collaboration.md

@@ -2,13 +2,11 @@
 # Collaboration with others
 
 * `git fetch`
-  * Get the remote branch reference pointer to the latest commit and cache it locally.
+  * Update the remote branch reference pointers to the latest commit and cache it locally.
+  * Does not pull in any remote commit history.
 * `git pull`
-  * Fetch and update the local history from remote repository. This pulls in source code changes and commits.
-* `git push`
-  * Update remote references and push local history to remote repository. This pushes source code changes and commits.
-* `git remote`
-  * Configure/list remote repository URLs (default `origin`).
+  * Fetch and update the local history from remote repository (implicit fetch).
+  * This pulls in source code changes and commits.
 
 ~~~SECTION:handouts~~~
 
@@ -18,6 +16,25 @@
 
 `git pull` invokes a fetch and updates the local history with commits from the remote repository.
 
+
+~~~ENDSECTION~~~
+
+
+!SLIDE smbullets
+# Collaboration with others
+
+* `git push`
+  * Update remote references and push local history to remote repository.
+  * This pushes source code changes and commits.
+  * Halts if the remote history diverged from your local history.
+* `git remote`
+  * Configure/list remote repository URLs (default `origin`).
+
+~~~SECTION:handouts~~~
+
+****
+
+
 `git push` updates remote references and pushes your local commit history to the remote repository.
 
 `git remote` allows you to configure and list the remote repository. By default this is called `origin`.

day1/07_Collaboration/04_Advanced.md

@@ -5,12 +5,6 @@
   * Put current changes on a temporary stack.
 * `git cherry-pick`
   * Collect specific commit into your working tree.
-* `git reset`
-  * Remove the current commit(s).
-  * `--soft` adds changes to the staging index.
-  * `--hard` drops them indefinitely.
-* `git archive`
-  * Create tarball without the `.git directory`.
 
 ~~~SECTION:handouts~~~
 
@@ -24,7 +18,6 @@ where your uncommitted changes will not apply.
 Use `git stash pop` to fetch the changes again. You can stash multiple uncommitted
 stages, `git stash list` will list them.
 
-`git archive` creates a tarball from the given working tree (HEAD or tag).
 ~~~ENDSECTION~~~
 
 

day2/01_Workflows/02_Centralized.md

@@ -95,14 +95,12 @@ for integrating and sharing code changes between repositories.
 * Objective:
  * Clone the training repository twice and add diverging commits
 * Steps:
- * Clone the `training.git` repository into `$HOME/training1`
- * Clone the `training.git` repository into `$HOME/training2`
+ * Clone the `training.git` repository into `$HOME/training1` and `$HOME/training2`
 * Steps for both:
  * Change into each directory
  * Add/modify a file and commit the change
  * Push your change to the remote repository
-* Next steps:
- * Explain the error message after the second push
+* Explain the error message after the second push
 
 
 !SLIDE supplemental exercises
@@ -201,13 +199,11 @@ The last parameter specifies the target directory `training2`.
 * Objective:
  * Rebase your local history with the remote repository
 * Steps:
- * Change into `$HOME/training`
  * Reset the local history by 2 commits with `git reset --hard HEAD~2`
  * Update and commit README.md
- * Fetch the remote repository and use `git diff origin/master` to compare the changes
- * Rebase the master branch against the remote master branch with `git rebase origin/master`
- * Resolve possible merge conflicts, add them and continue with `git rebase --continue`
- * Push your rebased history
+ * Fetch remote and compare with `git diff origin/master`
+ * Rebase with `git rebase origin/master`
+ * Resolve possible merge conflicts, add them and continue with `git rebase --continue`, push rebased history
 
 Hint: `>>>` marks conflicts and show the differences on merge.
 

day2/01_Workflows/03_Feature_Branch.md

@@ -119,16 +119,11 @@ The new branch `feature/docs-workflows` will be based on the `master` branch.
  * Update `master` branch and merge feature branch `feature/docs-workflows`
 
 * Steps:
- * Change into `$HOME/training`
  * Checkout the feature branch `feature/docs-workflows`
  * Edit `README.md`, add and commit the changes
  * Diff the feature branch to the current master with `git diff master`
- * Checkout the `master` branch
- * Merge the feature branch as non-fast-forward with `--no-ff`
- * Show the history tree with `tig` or inside GitLab
-
-* Bonus:
- * Explain why the forced merge commit with `--no-ff` is important
+ * Checkout the `master` branch, merge the feature branch as non-fast-forward with `--no-ff`
+ * Show the history tree with `tig` or inside GitLab and explain why the forced merge commit with `--no-ff` is important
 
 ~~~SECTION:handouts~~~
 

day2/01_Workflows/06_Github_Gitlab_Flow.md

@@ -20,10 +20,8 @@
 # Forking Workflow - How it works
 
 * Developers fork, commit and push into their own repository
-* Developers create a `Pull Request` for the official repository
-* CI triggers automated tests for the PR
-* Developers/Maintainers review and merge PR
-* CI triggers deployment task
+* Developers create a `Pull Request` for the official repository, CI triggers automated tests for the PR
+* Developers/Maintainers review and merge PR, CI triggers deployment task
 
 <center><img src="../../_images/workflows/git_github_workflow.png" alt="GitHub Workflow"/></center>
 

day2/01_Workflows/08_Rebase_Squash.md

@@ -12,6 +12,8 @@ all commits into one commit.
     commit2
     commit3
 
+Ask the trainer to draw an image for better illustration and discussion.
+
 !SLIDE smbullets
 # Lab ~~~SECTION:MAJOR~~~.~~~SECTION:MINOR~~~: Rebase and squash commits
 

day2/03_CI/04_Gitlab_CI.md

@@ -576,11 +576,9 @@ Example:
 * Objective:
  * Create HTML docs from Markdown
 * Steps:
- * Add a new job `markdown` after the `all_tests` job
- * Add `script` and convert `README.md` to `README.html` using Python
- * Add `archifacts` with `paths` pointing to `README.html`. Expires in `1 week`.
- * Commit and push the changes
- * Download and view the `README.html` file in your browser
+ * Add a new `markdown` and use `script` to generate `README.html`
+ * Add `archifacts` with `paths` pointing to `README.html`. Expires in `1 week`
+ * Commit and push the changes, then download and view the `README.html` file in your browser
 
 Example:
 

global/Post/03_Contributing.md

@@ -0,0 +1,13 @@
+!SLIDE noprint center
+# Contributing
+
+Contribute to the GitLab training on [GitHub](https://github.com/NETWAYS/gitlab-training) to make it even better.
+
+Material is licensed under [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International](http://creativecommons.org/licenses/by-nc-sa/4.0/).
+
+
+!SLIDE noprint smbullets
+# Contributors
+
+* Michael Friedrich
+* Markus Waldmüller