Skip to content

Commit

Permalink
cleaned slide layout
Browse files Browse the repository at this point in the history
  • Loading branch information
matteodelucchi committed Oct 28, 2024
1 parent e396edd commit 06f0bc9
Show file tree
Hide file tree
Showing 11 changed files with 20 additions and 14 deletions.
2 changes: 1 addition & 1 deletion source/content/elements/index_stage.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
:::{card} <i class="far fa-rectangle-list"></i> Index/Staging Area
{% endif %}

> In <i class="fab fa-git"></i> the _Staging Area_ or _Index_ refers to a set of modified files that are flagged to be include in a commit
> In <i class="fab fa-git"></i> the _Staging Area_ or _Index_ refers to a **set of modified files that are flagged to be included in a commit**.
The Staging Area:

Expand Down
2 changes: 1 addition & 1 deletion source/content/elements/working_dir.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
:::{card} <i class="fas fa-folder-open"></i> Working Directory
{% endif %}

> In <i class="fab fa-git"></i> the Working Directory refers to the **local folder you are viewing and editing** the content of the currently checked out branch
> In <i class="fab fa-git"></i>, the Working Directory refers to the **local folder you are viewing and editing** the content of the currently checked out branch.
The Working Directory:

Expand Down
4 changes: 3 additions & 1 deletion source/content/history/example.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@
### A Simple Example
{% endif %}

{% if page %}
```{admonition} <i class="fab fa-git"></i> <strong style="color:black">log</strong>: explore the history
:class: note, margin
- <i class="fas fa-code-commit"></i> commits are indicated with `* <hash...>` followed by the commit message
- <i class="fas fa-code-commit"></i> commits are indicated with `* <hash>` followed by the commit message
- <i class="fas fa-code-branch"></i> Branches, <i class="fas fa-tag"></i> Tags and <i class="fas fa-hat-wizard"></i> HEAD are indicated in `(...)` after the commit hash
```
{% endif %}

:::{card} `git log --all --decorate --oneline --graph`
:class: smaller
Expand Down
5 changes: 2 additions & 3 deletions source/content/intro/limitations/consistency.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
### Functional Consistency

```{admonition} <i class="fab fa-git"></i> 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 <i class="fab fa-git"></i> is not reporting any conflicts when merging changes from different sources.
Expand Down
8 changes: 5 additions & 3 deletions source/content/intro/limitations/sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <i class="fab fa-git"></i> 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 <i class="fab fa-git"></i> workflow
- collaboration mediated by <i class="fab fa-git"></i> 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 <i class="fab fa-git"></i> workflow.
3 changes: 3 additions & 0 deletions source/content/intro/limitations/tracking.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ This leads to limited support for:
- Filetypes that include metadata (e.g. `.docx`)
- Large files (<i class="fab fa-git"></i>'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.
Expand Down
2 changes: 1 addition & 1 deletion source/content/principles/healthy_reference.md
Original file line number Diff line number Diff line change
@@ -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 <i class="fab fa-git"></i>-context this translates to:

Expand Down
2 changes: 1 addition & 1 deletion source/content/principles/healthy_reference_best.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### Best Practice (1/4)

{% if build == "slides" %}
{% if build == "slide" %}
```{admonition} Best Practices
:class: tip, margin
Expand Down
2 changes: 1 addition & 1 deletion source/content/principles/separate_best.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### Best Practice (2/4)

{% if build == "slides" %}
{% if build == "slide" %}
```{admonition} Best Practices
:class: tip, margin
Expand Down
2 changes: 1 addition & 1 deletion source/content/principles/states_best.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### Best Practice (4/4)

{% if build == "slides" %}
{% if build == "slide" %}
```{admonition} Best Practices
:class: tip, margin
Expand Down
2 changes: 1 addition & 1 deletion source/content/principles/steps_best.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### Best Practice (3/4)

{% if build == "slides" %}
{% if build == "slide" %}
```{admonition} Best Practices
:class: tip, margin
Expand Down

0 comments on commit 06f0bc9

Please sign in to comment.