rougail-tutorials/README.md

• Summary
• [tutorial v1.1_001] Let’s add our first variable (diff)

[tutorial v1.1_002] Describe the variable

View the diff

Read the documentation

Screenshot

Clone and install

To test this tutorial, you need to download this repository and install Rougail:

git clone -b 1.1 https://forge.cloud.silique.fr/stove/rougail-tutorials.git
cd rougail-tutorials
python -m venv venv_rougail
. venv_rougail/bin/activate
pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-data-yaml

Then switch to the tutorial page:

git switch --detach v1.1_002

Structure

.
└── firefox
    └── 00-proxy.yml

Contents of the firefox/00-proxy.yml file

%YAML 1.2
---
version: 1.1

proxy_mode:  # Configure Proxy Access to the Internet
...

Let's generate the documentation

rougail -m firefox/ -o doc

Variable	Description
proxy_mode string mandatory	Configure Proxy Access to the Internet.

Let's generate the changelog

rougail -m firefox/ -o doc --doc.contents changelog

Modified variable

Variable	Description
proxy_mode string mandatory	Configure Proxy Access to the Internet.

User datas

Example 1

config/01/config.yml

---

Output

rougail -m firefox/ -u yaml -yf config/01/config.yml

🛑 ERRORS
┗━━ The following variables are mandatory but have no value:
    ┗━━ Configure Proxy Access to the Internet

Output in read write mode

rougail -m firefox/ -u yaml -yf config/01/config.yml --cli.read_write

╭──────────────────── Caption ─────────────────────╮
│ Undocumented but modified variable Default value │
╰──────────────────────────────────────────────────╯
Variables:
┗━━ 📓 Configure Proxy Access to the Internet: null

Example 2

config/02/config.yml

---
proxy_mode: No proxy

Output

rougail -m firefox/ -u yaml -yf config/02/config.yml

╭───────────────────── Caption ─────────────────────╮
│ Undocumented but modified variable Modified value │
╰───────────────────────────────────────────────────╯
Variables:
┗━━ 📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML 
    file "config/02/config.yml"

Example 3

config/03/config.yml

---
proxy_mode: foo

Output

rougail -m firefox/ -u yaml -yf config/03/config.yml

╭───────────────────── Caption ─────────────────────╮
│ Undocumented but modified variable Modified value │
╰───────────────────────────────────────────────────╯
Variables:
┗━━ 📓 Configure Proxy Access to the Internet: foo ◀ loaded from the YAML file 
    "config/03/config.yml"

• [tutorial v1.1_003] Set a default value (diff)