Skip to content

Commit

Permalink
Update some docs (#1)
Browse files Browse the repository at this point in the history
* feat: update some docs and add latex document
* add latex document
  • Loading branch information
badele authored May 5, 2024
1 parent 226aac3 commit be8a041
Show file tree
Hide file tree
Showing 44 changed files with 1,601 additions and 52 deletions.
17 changes: 10 additions & 7 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
.decrypted*.yml

# Project
docs/nvim/tags
public

# direnv
.direnv

# Devenv
.devenv*
devenv.local.nix
# LaTeX
*.aux
*.fdb_latexmk
*.fls
*.idx
*.ilg
*.ind
*.log
*.toc
19 changes: 10 additions & 9 deletions content/_index.en.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
---
title: Welcome to JSL Devops
title: Welcome
---

During our DevOps journey, we have used a multitude tools and infrastructure,
and encountered many problems.
During our DevOps journey, we use a multitude tools and infrastructure, and
encounter many problems.

Sometimes we have failed to document certain situations, thinking that we We
wouldn't encounter these problems anymore.
Sometimes we judge that it is not necessary to document certain situations,
thinking that we will no longer encounter these problems.

However, recently I have been working with different startups and I have
realized that I found myself repeating the same tasks.
However, recently I have been working with different startups and have found
myself realized that I found myself repeating practically the same tasks.

This is why I decided to create this documentation site to record the problems
we face and their solutions.
This is why I decided to create this site to document the tools that we use as
well as to record the problems we face in our daily lives and provide their
solutions.
19 changes: 10 additions & 9 deletions content/_index.fr.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
---
title: Bienvenue sur JSL Devops
title: Bienvenue
---

Au cours de notre parcours en tant que DevOps, nous avons utilisé une multitude
d'outils et d'infrastructures, et avons rencontré de nombreuses problématiques.
Au cours de notre parcours en tant que DevOps, nous utilisons une multitude
doutils et dinfrastructures, et rencontrons de nombreuses problématiques.

Parfois, nous avons omis de documenter certaines situations, pensant que nous ne
rencontrerions plus ces problèmes.
Parfois, nous jugeons qu'il n'est pas nécessaire de documenter certaines
situations, pensant que nous ne rencontrerons plus ces problématiques.

Cependant, récemment, j'ai travaillé avec différentes startups et je me suis
rendu compte que je me retrouvais à refaire les mêmes tâches.
Cependant, récemment, jai travaillé avec différentes startups et je me suis
rendu compte que je me retrouvais à refaire pratiquement les mêmes tâches.

C'est pourquoi j'ai décidé de créer ce site de documentation pour consigner les
problèmes auxquels nous sommes confrontés ainsi que leurs solutions.
C’est pourquoi j’ai décidé de créer ce site pour documenter les outils que nous
utilisons ainsi que pour consigner les problèmes auxquels nous sommes confrontés
dans notre quotidien et apporter leurs solutions.
3 changes: 3 additions & 0 deletions content/developer/_index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Develop
---
3 changes: 3 additions & 0 deletions content/developer/_index.fr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Developer
---
43 changes: 43 additions & 0 deletions content/developer/ghq/_index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: ghq
resources:
- name: demo-ghq
src: demo-ghq.gif
title: "ghq demo"
params:
credits: "generated with `vhs demo-ghq.tape`"
---

{{< hint type=note title=Intro >}} **[ghq](https://github.com/x-motemen/ghq)**
allows you to clone a project without worrying where the project will be cloned,
it allows also to clone while respecting the aborescende of the remote repo. {{<
/hint >}}

## git clone, it's simple!

The cloning process with the `git clone` command may seem simple at first
glance. at first glance, but when managing several **Git** repositories, this
can quickly become complex. This is even more true when working with repository
forks. The **ghq** tool simplifies this management by centralizing repositories
in a specific location on your machine.

Let's say you use work with **dotfiles** and you get a **dotfiles** with the
command `ghq get https://github.com/mathiasbynens/dotfiles.git`. And now you
also want to work on your **dotfiles**, no need to worry question where you were
going to clone your project, you just need to run
`ghq get https://github.com/badele/dotfiles.git`. After executing these orders,
the structure of the projects will be clearly organized in your **ghq**
directory.

```text
└─ ~/ghq
└─ github.com
├─ mathiasbynens
│ └─ dotfiles
└─ badele
└─ dotfiles
```

Here is an example of using **ghq**

{{< img name="demo-ghq" size=origin lazy=false >}}
43 changes: 43 additions & 0 deletions content/developer/ghq/_index.fr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: ghq
resources:
- name: demo-ghq
src: demo-ghq.gif
title: "ghq demo"
params:
credits: "generated with `vhs demo-ghq.tape`"
---

{{< hint type=note title=Intro >}} **[ghq](https://github.com/x-motemen/ghq)**
permet de cloner un projet sans se soucier où sera cloner le projet, il permet
égallement de cloner en respectant l'aborescende du repo distant. {{< /hint >}}

## git clone, c'est pourtant simple !

Le processus de clonage avec la commande `git clone` peut sembler simple au
premier abord, mais lorsqu'on gère plusieurs dépôts **Git**, cela peut
rapidement devenir complexe. C'est encore plus vrai lorsque l'on travaille avec
des forks de dépôts. L'outil **ghq** vient simplifier cette gestion en
centralisant les dépôts dans un emplacement spécifique sur votre machine.

Imaginons que vous utilisiez travailler avec des **dotfiles** et que vous
récupériez un **dotfiles** avec la commande
`ghq get https://github.com/mathiasbynens/dotfiles.git`. Et que maintenant vous
voulez égallement travailler sur votre **dotfiles**, pas besoins de se poser la
question où vous alliez cloner votre projet, il vous suffit d'exécuter
`ghq get https://github.com/badele/dotfiles.git`. Après l'exécution de ces
commandes, la structure des projets sera organisée de manière claire dans votre
répertoire **ghq**.

```text
└─ ~/ghq
└─ github.com
├─ mathiasbynens
│ └─ dotfiles
└─ badele
└─ dotfiles
```

Voici un exemple d'utilisation de **ghq**

{{< img name="demo-ghq" size=origin lazy=false >}}
Binary file added content/developer/ghq/demo-ghq.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 25 additions & 0 deletions content/developer/ghq/demo-ghq.tape
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
Output demo-ghq.gif

Require nix-shell

Set TypingSpeed 75ms
Set FontSize 12
Set Width 800
Set Height 680

Hide
Type "nix-shell -p ghq tree --run zsh" Sleep 500ms Enter Sleep 2s
Type "reset" Sleep 500ms Enter Sleep 2s
Show

Type "tree -d -L 6 ~/ghq" Sleep 500ms Enter Sleep 2s

Type "ghq get https://github.com/mathiasbynens/dotfiles.git" Sleep 500ms Enter Sleep 2s

Type "tree -d -L 6 ~/ghq" Sleep 500ms Enter Sleep 2s

Type "ghq get https://github.com/badele/dotfiles.git" Sleep 500ms Enter Sleep 2s

Type "tree -d -L 6 ~/ghq" Sleep 500ms Enter Sleep 2s

Sleep 5s
50 changes: 50 additions & 0 deletions content/documenter/VHS/_index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: VHS
resources:
- name: demo-vhs
src: demo-vhs.gif
title: "VHS demo"
params:
credits: "generated with `vhs demo-vhs.tape`"
---

{{< hint type=note title=Intro >}} Sometimes, **A picture is worth a thousand
words**. [VHS](https://github.com/charmbracelet/vhs) is the perfect tool to
explain in animated image how to use command line tools {{< /hint >}}

## VHS in pictures

[VHS](https://github.com/charmbracelet/vhs) is a substantially identical tool at
[asciinema](https://asciinema.org/). Nevertheless **VHS** uses an approach
declarative (via the creation of a `.tape` file). It allows you to automate the
execution of a scenario composed of a series of commands to be executed, to then
record the results of the actions in the form of videos in different formats
(webm, mp4, gif), which can be particularly useful for documentation or
knowledge sharing.

Starting from this `demo-vhs.tape` file

```text
Output demo-vhs.gif
Require nix
Set TypingSpeed 75ms
Set FontSize 18
Set Width 800
Set Height 680
Type "# Install the needed packages" Sleep 500ms Enter Enter Sleep 2s
Type "nix-shell -p dotacat neofetch"
Type "neofetch" Sleep 500ms Enter Sleep 2s
Type "dotacat --help | dotacat" Sleep 500ms Enter
Sleep 5s
```

We obtain the result below with the following command `vhs demo-vhs.tape`

{{< img name="demo-vhs" size=origin lazy=false >}}
50 changes: 50 additions & 0 deletions content/documenter/VHS/_index.fr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: VHS
resources:
- name: demo-vhs
src: demo-vhs.gif
title: "VHS demo"
params:
credits: "generated with `vhs demo-vhs.tape`"
---

{{< hint type=note title=Intro >}} Parfois, **Une image vaut mille mots**.
[VHS](https://github.com/charmbracelet/vhs) est l'outil parfait expliquer en
image animée comment utiliser des outils en ligne de commande {{< /hint >}}

## VHS en image

[VHS](https://github.com/charmbracelet/vhs) est un outil sensiblement identique
à [asciinema](https://asciinema.org/). Néamoins **VHS** utilise une approche
déclarative (via la création de fichier `.tape`). Il permet d'automatiser
l'éxecution d'un scénario composé d'une suite de commandes à executer, pour
ensuite enregrister le résultat des actions sous forme de videos dans différents
formats (webm, mp4, gif), ce qui peut être particulièrement utile pour la
documentation ou le partage de connaissances.

En partant de ce fichier `demo-vhs.tape`

```text
Output demo-vhs.gif
Require nix
Set TypingSpeed 75ms
Set FontSize 18
Set Width 800
Set Height 680
Type "# Install the needed packages" Sleep 500ms Enter Enter Sleep 2s
Type "nix-shell -p dotacat neofetch"
Type "neofetch" Sleep 500ms Enter Sleep 2s
Type "dotacat --help | dotacat" Sleep 500ms Enter
Sleep 5s
```

Nous obtenos le résultat ci-dessous avec commande suivante `vhs demo-vhs.tape`

{{< img name="demo-vhs" size=origin lazy=false >}}
Binary file added content/documenter/VHS/demo-vhs.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 18 additions & 0 deletions content/documenter/VHS/demo-vhs.tape
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Output demo-vhs.gif

Require nix-shell

Set TypingSpeed 75ms
Set FontSize 12
Set Width 800
Set Height 680

Type "# Install the needed packages" Sleep 500ms Enter Enter Sleep 2s

Type "nix-shell -p dotacat neofetch" Sleep 500ms Enter Sleep 4s

Type "neofetch" Sleep 500ms Enter Sleep 2s

Type "dotacat --help | dotacat" Sleep 500ms Enter

Sleep 5s
17 changes: 9 additions & 8 deletions content/documenter/geekdoc/_index.en.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Geekdoc
title: geekdoc
url: document/geekdoc
resources:
- name: demo-geekdoc
src: demo-geekdoc.gif
Expand Down Expand Up @@ -29,6 +30,13 @@ inherit the following features:
But above all thanks to hugo, it is possible to have a documentation site
statistics (no need for `PHP` or `Node.js` server)

## Example of use

Here is an example of using this template for the site
[JSL Devops documentation](https://devops.jesuislibre.org)

{{< img name="demo-geekdoc" size=origin lazy=false >}}

## Install

Installing `Geekdoc` will use the trio
Expand All @@ -49,10 +57,3 @@ cd geekdoc
nix develop
sh init_project
```

## Example of use

Here is an example of using this template for the site
[JSL Devops documentation](https://devops.jesuislibre.org)

{{< img name="demo-geekdoc" size=origin lazy=false >}}
Loading

0 comments on commit be8a041

Please sign in to comment.