From 06f0bc95525c974d73959c8f49dbef3991491ee3 Mon Sep 17 00:00:00 2001 From: Matteo Delucchi Date: Mon, 28 Oct 2024 11:42:19 +0100 Subject: [PATCH] cleaned slide layout --- source/content/elements/index_stage.md | 2 +- source/content/elements/working_dir.md | 2 +- source/content/history/example.md | 4 +++- source/content/intro/limitations/consistency.md | 5 ++--- source/content/intro/limitations/sync.md | 8 +++++--- source/content/intro/limitations/tracking.md | 3 +++ source/content/principles/healthy_reference.md | 2 +- source/content/principles/healthy_reference_best.md | 2 +- source/content/principles/separate_best.md | 2 +- source/content/principles/states_best.md | 2 +- source/content/principles/steps_best.md | 2 +- 11 files changed, 20 insertions(+), 14 deletions(-) diff --git a/source/content/elements/index_stage.md b/source/content/elements/index_stage.md index 7658b25..2af4ab6 100644 --- a/source/content/elements/index_stage.md +++ b/source/content/elements/index_stage.md @@ -5,7 +5,7 @@ :::{card} Index/Staging Area {% endif %} -> In the _Staging Area_ or _Index_ refers to a set of modified files that are flagged to be include in a commit +> In the _Staging Area_ or _Index_ refers to a **set of modified files that are flagged to be included in a commit**. The Staging Area: diff --git a/source/content/elements/working_dir.md b/source/content/elements/working_dir.md index 5a648ee..ed7fc7d 100644 --- a/source/content/elements/working_dir.md +++ b/source/content/elements/working_dir.md @@ -5,7 +5,7 @@ :::{card} Working Directory {% endif %} -> In the Working Directory refers to the **local folder you are viewing and editing** the content of the currently checked out branch +> In , the Working Directory refers to the **local folder you are viewing and editing** the content of the currently checked out branch. The Working Directory: diff --git a/source/content/history/example.md b/source/content/history/example.md index 79b6579..c2c26c0 100644 --- a/source/content/history/example.md +++ b/source/content/history/example.md @@ -2,12 +2,14 @@ ### A Simple Example {% endif %} +{% if page %} ```{admonition} log: explore the history :class: note, margin -- commits are indicated with `* ` followed by the commit message +- commits are indicated with `* ` followed by the commit message - Branches, Tags and HEAD are indicated in `(...)` after the commit hash ``` +{% endif %} :::{card} `git log --all --decorate --oneline --graph` :class: smaller diff --git a/source/content/intro/limitations/consistency.md b/source/content/intro/limitations/consistency.md index 6dd1e92..8b1dbb0 100644 --- a/source/content/intro/limitations/consistency.md +++ b/source/content/intro/limitations/consistency.md @@ -1,14 +1,13 @@ ### Functional Consistency - ```{admonition} tracks only the content of files :class: warning -It does not track the functionality of whatever the content implements. +Git tracks only the content of files, not the functionality of the code within them. ``` There is **no** guarantee that: - Git will identify breaking changes as a conflict{% if page %}[^sn3]{% endif %} -- Two functioning versions do not lead to a dysfunctional combination +- Two functioning versions combined will not result in a dysfunctional version {% if page %} [^sn3]: This is rather obvious, if you think about it. But is something that might not be thought about if is not reporting any conflicts when merging changes from different sources. diff --git a/source/content/intro/limitations/sync.md b/source/content/intro/limitations/sync.md index 406a705..2e98727 100644 --- a/source/content/intro/limitations/sync.md +++ b/source/content/intro/limitations/sync.md @@ -3,10 +3,12 @@ ```{admonition} No coupling between changes and distribution :class: warning Synchronization is not coupled to change events in a repository. +{% if page %} This means that just because a change (like a commit) happens in the repository, it doesn't automatically trigger synchronization across all copies (clones) of the repository. +{% endif %} ``` Therefore: -- collaboration mediated by happens asynchronously, i.e., changes are propagated when explicitly requested (e.g., by pushing or pulling). -- simultaneous editing is not supported. If two users edit the same file at the same time, the changes must be merged manually. -- synchronizing the state of a repository is part of the workflow +- collaboration mediated by happens asynchronously{% if page %}, i.e., changes are propagated when explicitly requested (e.g., by pushing or pulling).{% endif %} +- simultaneous editing is not supported.{% if page %} If two users edit the same file at the same time, the changes must be merged manually.{% endif %} +- synchronizing the state of a repository is part of the workflow. diff --git a/source/content/intro/limitations/tracking.md b/source/content/intro/limitations/tracking.md index b9a293f..cefc36c 100644 --- a/source/content/intro/limitations/tracking.md +++ b/source/content/intro/limitations/tracking.md @@ -11,6 +11,9 @@ This leads to limited support for: - Filetypes that include metadata (e.g. `.docx`) - Large files ('s size limit for a single file is 2 GB){% if page %}[^sn4]{% endif %} +{% if slides %} +How to deal with these limitations will be discussed later. +{% endif %} {% if page %} [^sn4]: Git LFS (Large File Storage) is a solution to this problem. It allows to store binary files outside of the repository and only track their location and version. diff --git a/source/content/principles/healthy_reference.md b/source/content/principles/healthy_reference.md index 35bc2a1..c0d4b02 100644 --- a/source/content/principles/healthy_reference.md +++ b/source/content/principles/healthy_reference.md @@ -1,6 +1,6 @@ ## Healthy Reference -> A pre-requirement to successfully develop any change, or new feature, is **to be able to depart from a functional state**. +> A pre-requirement to successfully develop any change, or new feature, is **to be able to start-off from a functional state**. In the -context this translates to: diff --git a/source/content/principles/healthy_reference_best.md b/source/content/principles/healthy_reference_best.md index 75346dc..7ac9d53 100644 --- a/source/content/principles/healthy_reference_best.md +++ b/source/content/principles/healthy_reference_best.md @@ -1,6 +1,6 @@ ### Best Practice (1/4) -{% if build == "slides" %} +{% if build == "slide" %} ```{admonition} Best Practices :class: tip, margin diff --git a/source/content/principles/separate_best.md b/source/content/principles/separate_best.md index 163c151..ca13ca9 100644 --- a/source/content/principles/separate_best.md +++ b/source/content/principles/separate_best.md @@ -1,6 +1,6 @@ ### Best Practice (2/4) -{% if build == "slides" %} +{% if build == "slide" %} ```{admonition} Best Practices :class: tip, margin diff --git a/source/content/principles/states_best.md b/source/content/principles/states_best.md index 777d413..6eb7007 100644 --- a/source/content/principles/states_best.md +++ b/source/content/principles/states_best.md @@ -1,6 +1,6 @@ ### Best Practice (4/4) -{% if build == "slides" %} +{% if build == "slide" %} ```{admonition} Best Practices :class: tip, margin diff --git a/source/content/principles/steps_best.md b/source/content/principles/steps_best.md index b8d9eca..0c7374c 100644 --- a/source/content/principles/steps_best.md +++ b/source/content/principles/steps_best.md @@ -1,6 +1,6 @@ ### Best Practice (3/4) -{% if build == "slides" %} +{% if build == "slide" %} ```{admonition} Best Practices :class: tip, margin