Render README.qmd

README.md

@@ -0,0 +1,73 @@
+Advanced `git`
+================
+Jan Simson
+
+This repository contains the course materials for a one-day workshop
+titled “Advaned `git`” which I first gave at the Steinbruch Center for
+Computing (SCC).
+
+## Contents
+
+### Slides
+
+- Block 1: Intro, Recap & Merging
+  - 1.0 Intro [\[slides\]](output/1.0-intro.html)
+  - 1.1 Basics of git [\[slides\]](output/1.1-git-basics.html)
+  - 1.2 Branches & Merging [\[slides\]](1.2-branches_merging.html)
+- Block 2: Best Practices: Pull / Merge Requests, Trunk-Based
+  Development
+  - 2.1 Collaboration & Merge Requests
+    [\[slides\]](output/2.1-collaboration-merge-requests.html)
+  - 2.2 Trunk Based Development
+    [\[slides\]](output/2.2-trunk-based-development.html)
+- Block 3: CI / CD with gitlab
+  - 3.1 GitLab CI / CD [\[slides\]](output/3.1-gitlab-CI-CD.html)
+- Block 4: Stashes, Cherry Picking, Patches & more
+  - 4.1 Advanced Features of git
+    [\[slides\]](output/4.1-advanced-features.html)
+  - 4.2 Final Notes [\[slides\]](output/4.2-final_notes.html)
+  - *Outro*
+
+<!-- *: Since they have to be manually generated, the PDF version of slides may be slightly outdated. Please refer to [this guide](https://revealjs.com/pdf-export/), on how to export your own PDF version from the online slides. -->
+
+### Supporting Documents
+
+- Supplementary [student information
+  sheet](output/resources/student-info/student-info.pdf)
+- How to Setup SSH authentication for GitLab
+  [\[PDF\]](output/resources/ssh/how-to-setup-gitlab-ssh.pdf)
+  [\[HTML\]](output/resources/ssh/how-to-setup-gitlab-ssh.html)
+- Git Cheatsheet [\[PDF\]](resources/git-cheat-sheet-education.pdf)
+  - By [GitHub Education](https://education.github.com/)
+
+## Links
+
+- Repositories used in the Course
+  - [GitLab Website
+    Template](https://gitlab.com/jansim/website-template)
+- Guides to review & refresh your knowledge
+  - <https://gitimmersion.com>
+  - <https://github.com/git-guides>
+  - [Introduction to RStudio Git &
+    GitHub](https://malikaihle.github.io/Introduction-RStudio-Git-GitHub/)
+  - [The Carpentries: Version Control with
+    Git](https://swcarpentry.github.io/git-novice/)
+- Further reading (beyond the contents of the course)
+  - [Trunk Based
+    Development](https://www.atlassian.com/continuous-delivery/continuous-integration/trunk-based-development),
+    a popular and advanced workflow of using git (currently concidered a
+    best-practice)
+  - Using git with data
+    - [dvc](https://dvc.org/): Data Version Control
+    - [git lfs](https://git-lfs.github.com/): Git Large File Storage
+  - If you have a problem
+    - [ohshitgit.com](https://ohshitgit.com/)
+      [(🇩🇪)](https://ohshitgit.com/de)
+    - Google: Just googling your problem is often the most useful
+      solution
+
+## License
+
+The contents of this course which were created by me are available under
+CC-BY-4.0. For resources where I do not own the copyright, other
+licenses may apply.