[tutorial 011] The variable description (config and doc)
This commit is contained in:
parent
da86875b6f
commit
d0a9b40bec
3 changed files with 12 additions and 11 deletions
17
README.md
17
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**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Proxy_mode. |
|
||||
| **proxy_mode**<br/>[`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
|
|||
```
|
||||
<pre>🛑 ERRORS
|
||||
<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
|
||||
<span style="color: #ff0000">┗━━ </span> - proxy_mode
|
||||
<span style="color: #ff0000">┗━━ </span> - proxy_mode (Configure Proxy Access to the Internet)
|
||||
</pre>
|
||||
### Example 2
|
||||
|
||||
|
|
@ -143,10 +144,10 @@ proxy_mode: 1
|
|||
foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml
|
||||
```
|
||||
<pre>🛑 ERRORS
|
||||
<span style="color: #ff0000">┣━━ </span>"1" is an invalid string for "proxy_mode"
|
||||
<span style="color: #ff0000">┣━━ </span>"1" is an invalid string for "proxy_mode (Configure Proxy Access to the Internet)"
|
||||
<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
|
||||
<span style="color: #ff0000">┗━━ </span> - proxy_mode
|
||||
<span style="color: #ff0000">┗━━ </span> - proxy_mode (Configure Proxy Access to the Internet)
|
||||
</pre>
|
||||
|
||||
|
||||
- [[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))
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<pre>🛑 ERRORS
|
||||
<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
|
||||
<span style="color: #ff0000">┗━━ </span> - proxy_mode
|
||||
<span style="color: #ff0000">┗━━ </span> - proxy_mode (Configure Proxy Access to the Internet)
|
||||
</pre>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<pre>🛑 ERRORS
|
||||
<span style="color: #ff0000">┣━━ </span>"1" is an invalid string for "proxy_mode"
|
||||
<span style="color: #ff0000">┣━━ </span>"1" is an invalid string for "proxy_mode (Configure Proxy Access to the Internet)"
|
||||
<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
|
||||
<span style="color: #ff0000">┗━━ </span> - proxy_mode
|
||||
<span style="color: #ff0000">┗━━ </span> - proxy_mode (Configure Proxy Access to the Internet)
|
||||
</pre>
|
||||
|
|
|
|||
Loading…
Reference in a new issue