diff --git a/README.md b/README.md index 34b22ce..1aa714c 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ - [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) -- [[tutorial 001] The format version in commandline](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_001~1..v1.1_001)) +- [[tutorial 010] A first variable with only a name](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_010/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_010~1..v1.1_010)) -# [tutorial 010] A first variable with only a name +# [tutorial 011] The variable description -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_010~1..v1.1_010) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_011~1..v1.1_011) ## Screenshot @@ -21,6 +21,7 @@ ```yml --- proxy_mode: + description: Configure Proxy Access to the Internet ``` ### Generated documentation @@ -32,7 +33,7 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -o doc -do github | Variable                                                                                        | Description                                                                                     | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **proxy_mode**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Proxy_mode. | +| **proxy_mode**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet. | ## User data @@ -53,7 +54,7 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/01/config.yaml ```
🛑 ERRORS
 ┣━━ The following variables are mandatory but have no value:
-┗━━   - proxy_mode
+┗━━   - proxy_mode (Configure Proxy Access to the Internet)
 
### Example 2 @@ -143,10 +144,10 @@ proxy_mode: 1 foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml ```
🛑 ERRORS
-┣━━ "1" is an invalid string for "proxy_mode"
+┣━━ "1" is an invalid string for "proxy_mode (Configure Proxy Access to the Internet)"
 ┣━━ The following variables are mandatory but have no value:
-┗━━   - proxy_mode
+┗━━   - proxy_mode (Configure Proxy Access to the Internet)
 
-- [[tutorial 011] The variable description](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_011/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_011~1..v1.1_011)) +- [[tutorial 012] A default value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_012/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_012~1..v1.1_012)) diff --git a/config/01/output_ro.html b/config/01/output_ro.html index e58ba7f..cebaee7 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -1,4 +1,4 @@
🛑 ERRORS
 ┣━━ The following variables are mandatory but have no value:
-┗━━   - proxy_mode
+┗━━   - proxy_mode (Configure Proxy Access to the Internet)
 
diff --git a/config/05/output_ro.html b/config/05/output_ro.html index 8deb760..ae251c2 100644 --- a/config/05/output_ro.html +++ b/config/05/output_ro.html @@ -1,5 +1,5 @@
🛑 ERRORS
-┣━━ "1" is an invalid string for "proxy_mode"
+┣━━ "1" is an invalid string for "proxy_mode (Configure Proxy Access to the Internet)"
 ┣━━ The following variables are mandatory but have no value:
-┗━━   - proxy_mode
+┗━━   - proxy_mode (Configure Proxy Access to the Internet)