🚚 move advanced content out of Readme to it's own page

enryH · enryH · commit 61e9276cd003 · 2025-10-30T12:57:25.000+01:00
diff --git a/README.md b/README.md
@@ -54,7 +54,7 @@ src="https://docs.google.com/presentation/d/1RsKMiKquE4wqncrAv9LEtjivGE_dGiHoJ8n
 frameborder="0"
 width="100%" height="480" 
 allowfullscreen="true"
- mozallowfullscreen="true" 
+mozallowfullscreen="true" 
 webkitallowfullscreen="true">
 </iframe>
 
@@ -67,89 +67,5 @@ See [local_setup](local_setup.md) for instructions to setup git on your local co
 - [git-intro by coderefinery](https://coderefinery.github.io/git-intro/#)
 - [git-moji](https://gitmoji.dev/)
 - [Git Internals - Plumbing and Porcelain](https://git-scm.com/book/en/v2/Git-Internals-Plumbing-and-Porcelain)
-- [Glossary of terms (technical for git)](https://www.git-scm.com/docs/gitglossary)
-- [GitHub Glossary terms](https://docs.github.com/en/get-started/learning-about-github/github-glossary)
-
-## Git under the hood (Extended version)
-
-> Extended content for those interested in how git works under the hood
-
-You can find a recording of the
-[talk](https://www.youtube.com/watch?v=cAU3BCUkHxM)
-([slides](https://docs.google.com/presentation/d/1RsKMiKquE4wqncrAv9LEtjivGE_dGiHoJ8nKCxgVKeY/edit?usp=sharing))
-and [hands-on tutorial](https://www.youtube.com/watch?v=5iB7qc5zRjQ)
-on YouTube which was done for the Data Club seminar
-between DTU biosustain and DTU bioengineering (see sections in description of Video).
-
-Talk:
-[![Recording of talk](https://img.youtube.com/vi/cAU3BCUkHxM/maxresdefault.jpg)](https://www.youtube.com/watch?v=cAU3BCUkHxM)
-
-Live Demo:
-[![Live Demo of Hands On part](https://img.youtube.com/vi/5iB7qc5zRjQ/maxresdefault.jpg)](https://www.youtube.com/watch?v=5iB7qc5zRjQ)
-
-The above Live Demo is not pulling the merge commit after merging the branch on GitHub:
-[github.com/biosustain/git_training_henry_recording](https://github.com/biosustain/git_training_henry_recording)
-
-I show the merge commit in the video below, cloining the recording repository in a newly
-create VSCode sandbox environment above:
-
-[![Live Demo Hand on Addon](https://img.youtube.com/vi/gcfzruIJ-rw/sddefault.jpg)](https://www.youtube.com/watch?v=gcfzruIJ-rw)
-
-### Instructions
-
-- create a folder with an empty repository (default `examples`
-  directly openend in VSCode on binder)
-- open instruction: `code-server ../README.md` (local computer: `code ../README.md`)
-- `git init` in console to initialize repo (or via command palette "Git: Initialize Repository")
-- setup user.name and user.email (see above)
-- create files, stage them and see what files are created in `.git/objects`
-- commit files and check `.git/objects`
-- create branches and checkout `.git/refs` (`git/branches` is a legacy folder,see
-  [here](https://stackoverflow.com/a/10398507/9684872))
-- look at `git/HEAD` (maybe `git/ORIG_HEAD` if it exists)
-
-> try to create your own fork, and try to lauch it on [mybinder](https://mybinder.org/)
-
-### Inspect git objects
-
-```bash
-git log --format=raw
-git cat-file -p <hash> # pretty print
-git cat-file -t <hash> # type
-
-# the binary object can also be inspected using different tools,
-# which might make it easier to navigate to certain blobs:
-cat .git/objects/<2c>/<38c> | zlib-flate -uncompress
-```
-
-You can find the latest objects and compare it to the log
-
-```bash
-find .git/objects  -type f -exec ls -lt {} + | head -n 10
-git log --format=raw -n 3
-```
-
-If you wonder what the codes in a tree mean, check this stackexchange
-[answer](https://unix.stackexchange.com/a/450488/349761)
-
-### What's happening?
-
-Can you explain what happens in the following scenarios?
-
-- You committed ten commits and did not yet push. Git complains about too much data.
-  You realize that you committed your source data. You delete it and commit again,
-  but the problem still persists.
-- You commit something and push. You realize your last commit was wrong. You undo it
-  and commit again. Git complains that you cannot push.
-
-### Git internals resources
-
-- [curious git](https://matthew-brett.github.io/curious-git/) - detailed intro to the
-  inner workings
-- [git parable](http://practical-neuroimaging.github.io/git_parable.html) - why git came to exist
-- Videos:
-  - [Python-Git-Client](https://www.youtube.com/watch?v=xvzo_nV9PjU)
-  - [Git-Interals](https://www.youtube.com/watch?v=MYP56QJpDr4) - shows how git works
-  - [Git PyData Global 2021 talk](https://www.youtube.com/watch?v=rBYC3dEOOyI)
-  - Scoot Chacon’s [“So you thin you know git” talk](https://www.youtube.com/watch?v=aolI_Rz0ZqY) (FOSDEM 2024),
-    notes on [blog](https://blog.gitbutler.com/git-tips-1-theres-a-git-config-for-that/)
+- [Glossary of terms for git](https://www.git-scm.com/docs/gitglossary)
+- [Glossary terms for GitHub](https://docs.github.com/en/get-started/learning-about-github/github-glossary)
diff --git a/advanced.md b/advanced.md
@@ -0,0 +1,84 @@
+
+# Git under the hood
+
+> Extended content for those interested in how git works under the hood
+
+You can find a recording of the
+[talk](https://www.youtube.com/watch?v=cAU3BCUkHxM)
+([slides](https://docs.google.com/presentation/d/1RsKMiKquE4wqncrAv9LEtjivGE_dGiHoJ8nKCxgVKeY/edit?usp=sharing))
+and [hands-on tutorial](https://www.youtube.com/watch?v=5iB7qc5zRjQ)
+on YouTube which was done for the Data Club seminar
+between DTU biosustain and DTU bioengineering (see sections in description of Video).
+
+Talk:
+[![Recording of talk](https://img.youtube.com/vi/cAU3BCUkHxM/maxresdefault.jpg)](https://www.youtube.com/watch?v=cAU3BCUkHxM)
+
+Live Demo:
+[![Live Demo of Hands On part](https://img.youtube.com/vi/5iB7qc5zRjQ/maxresdefault.jpg)](https://www.youtube.com/watch?v=5iB7qc5zRjQ)
+
+The above Live Demo is not pulling the merge commit after merging the branch on GitHub:
+[github.com/biosustain/git_training_henry_recording](https://github.com/biosustain/git_training_henry_recording)
+
+I show the merge commit in the video below, cloining the recording repository in a newly
+create VSCode sandbox environment above:
+
+[![Live Demo Hand on Addon](https://img.youtube.com/vi/gcfzruIJ-rw/sddefault.jpg)](https://www.youtube.com/watch?v=gcfzruIJ-rw)
+
+## Instructions
+
+- create a folder with an empty repository (default `examples`
+  directly openend in VSCode on binder)
+- open instruction: `code-server ../README.md` (local computer: `code ../README.md`)
+- `git init` in console to initialize repo (or via command palette "Git: Initialize Repository")
+- setup user.name and user.email (see above)
+- create files, stage them and see what files are created in `.git/objects`
+- commit files and check `.git/objects`
+- create branches and checkout `.git/refs` (`git/branches` is a legacy folder,see
+  [here](https://stackoverflow.com/a/10398507/9684872))
+- look at `git/HEAD` (maybe `git/ORIG_HEAD` if it exists)
+
+> try to create your own fork, and try to lauch it on [mybinder](https://mybinder.org/)
+
+## Inspect git objects
+
+```bash
+git log --format=raw
+git cat-file -p <hash> # pretty print
+git cat-file -t <hash> # type
+
+# the binary object can also be inspected using different tools,
+# which might make it easier to navigate to certain blobs:
+cat .git/objects/<2c>/<38c> | zlib-flate -uncompress
+```
+
+You can find the latest objects and compare it to the log
+
+```bash
+find .git/objects  -type f -exec ls -lt {} + | head -n 10
+git log --format=raw -n 3
+```
+
+If you wonder what the codes in a tree mean, check this stackexchange
+[answer](https://unix.stackexchange.com/a/450488/349761)
+
+## What's happening?
+
+Can you explain what happens in the following scenarios?
+
+- You committed ten commits and did not yet push. Git complains about too much data.
+  You realize that you committed your source data. You delete it and commit again,
+  but the problem still persists.
+- You commit something and push. You realize your last commit was wrong. You undo it
+  and commit again. Git complains that you cannot push.
+
+## Git internals resources
+
+- [curious git](https://matthew-brett.github.io/curious-git/) - detailed intro to the
+  inner workings
+- [git parable](http://practical-neuroimaging.github.io/git_parable.html) - why git came to exist
+- Videos:
+  - [Python-Git-Client](https://www.youtube.com/watch?v=xvzo_nV9PjU)
+  - [Git-Interals](https://www.youtube.com/watch?v=MYP56QJpDr4) - shows how git works
+  - [Git PyData Global 2021 talk](https://www.youtube.com/watch?v=rBYC3dEOOyI)
+  - Scoot Chacon’s [“So you thin you know git” talk](https://www.youtube.com/watch?v=aolI_Rz0ZqY) (FOSDEM 2024),
+    notes on [blog](https://blog.gitbutler.com/git-tips-1-theres-a-git-config-for-that/)
diff --git a/index.md b/index.md
@@ -5,7 +5,7 @@
 ```{toctree}
 :maxdepth: 1
 :hidden:
-:caption: 2025
+:caption: Basic introduction
 
 instructions_251105
 
@@ -17,7 +17,8 @@ receipe_book
 ```{toctree}
 :maxdepth: 1
 :hidden:
-:caption: 2024
+:caption: Advanced content
 
+advanced
 instructions_241113
 ```
