[tutorial v1.1_003)] Set a default value (config and doc)
This commit is contained in:
parent
8cb7bdb47e
commit
f1f26be80d
7 changed files with 41 additions and 51 deletions
53
README.md
53
README.md
|
|
@ -1,11 +1,11 @@
|
|||
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
||||
- [[tutorial v1.1_001] Let’s add our first variable](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 v1.1_002] Describe the variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_002~1..v1.1_002))
|
||||
|
||||
# [tutorial v1.1_002)] Describe the variable
|
||||
# [tutorial v1.1_003)] Set a default value
|
||||
|
||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_002~1..v1.1_002)
|
||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_003~1..v1.1_003)
|
||||
|
||||
[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#describe-the-variable)
|
||||
[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#set-a-default-value)
|
||||
|
||||
|
||||
## Screenshot
|
||||
|
|
@ -31,7 +31,7 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-
|
|||
Then switch to the tutorial page:
|
||||
|
||||
```shell
|
||||
git switch --detach v1.1_002
|
||||
git switch --detach v1.1_003
|
||||
```
|
||||
|
||||
## Structure
|
||||
|
|
@ -39,9 +39,9 @@ git switch --detach v1.1_002
|
|||
|
||||
|
||||
<p>
|
||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/./">.</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/./firefox/">firefox</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_003/./">.</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_003/./firefox/">firefox</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_003/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
||||
<br/><br/></p>
|
||||
|
||||
Contents of the firefox/00-proxy.yml file
|
||||
|
|
@ -51,7 +51,7 @@ Contents of the firefox/00-proxy.yml file
|
|||
---
|
||||
version: 1.1
|
||||
|
||||
proxy_mode: # Configure Proxy Access to the Internet
|
||||
proxy_mode: No proxy # Configure Proxy Access to the Internet
|
||||
...
|
||||
|
||||
```
|
||||
|
|
@ -62,7 +62,7 @@ rougail -m firefox/ -o doc
|
|||
```
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **proxy_mode**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet. |
|
||||
| **proxy_mode**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.<br/>**Default**: No proxy |
|
||||
|
||||
### Let's generate the changelog
|
||||
|
||||
|
|
@ -73,7 +73,7 @@ rougail -m firefox/ -o doc --doc.contents changelog
|
|||
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **proxy_mode**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | <ins>Configure Proxy Access to the Internet.</ins> |
|
||||
| **proxy_mode**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.<br/>**Default**: <ins>No proxy</ins> |
|
||||
|
||||
|
||||
## User datas
|
||||
|
|
@ -91,20 +91,11 @@ rougail -m firefox/ -o doc --doc.contents changelog
|
|||
```shell
|
||||
rougail -m firefox/ -u yaml -yf config/01/config.yml
|
||||
```
|
||||
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
|
||||
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Configure Proxy Access to the Internet
|
||||
</pre>
|
||||
#### Output in read write mode
|
||||
|
||||
```shell
|
||||
rougail -m firefox/ -u yaml -yf config/01/config.yml --cli.read_write
|
||||
```
|
||||
<pre>╭─────── Caption ────────╮
|
||||
│ Variable <span style="color: #ffd700">Default value</span> │
|
||||
╰────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">null</span>
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
|
||||
</pre>
|
||||
### Example 2
|
||||
|
||||
|
|
@ -120,11 +111,12 @@ proxy_mode: No proxy
|
|||
```shell
|
||||
rougail -m firefox/ -u yaml -yf config/02/config.yml
|
||||
```
|
||||
<pre>╭──────── Caption ────────╮
|
||||
│ Variable Modified value │
|
||||
╰─────────────────────────╯
|
||||
<pre>╭────────────── Caption ───────────────╮
|
||||
│ Variable Modified value │
|
||||
│ (<span style="color: #00aa00">⏳ Original default value</span>) │
|
||||
╰──────────────────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML file "config/02/config.yml"
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML file "config/02/config.yml" (⏳ <span style="color: #00aa00">No proxy</span>)
|
||||
</pre>
|
||||
### Example 3
|
||||
|
||||
|
|
@ -140,12 +132,13 @@ proxy_mode: foo
|
|||
```shell
|
||||
rougail -m firefox/ -u yaml -yf config/03/config.yml
|
||||
```
|
||||
<pre>╭──────── Caption ────────╮
|
||||
│ Variable Modified value │
|
||||
╰─────────────────────────╯
|
||||
<pre>╭────────────── Caption ───────────────╮
|
||||
│ Variable Modified value │
|
||||
│ (<span style="color: #00aa00">⏳ Original default value</span>) │
|
||||
╰──────────────────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: foo ◀ loaded from the YAML file "config/03/config.yml"
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: foo ◀ loaded from the YAML file "config/03/config.yml" (⏳ <span style="color: #00aa00">No proxy</span>)
|
||||
</pre>
|
||||
|
||||
|
||||
- [[tutorial v1.1_003] Set a default value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_003/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_003~1..v1.1_003))
|
||||
- [[tutorial v1.1_010] A variable with a list of possible values](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))
|
||||
|
|
|
|||
|
|
@ -1 +0,0 @@
|
|||
rougail -m firefox/ -u yaml -yf config/01/config.yml --cli.read_write
|
||||
|
|
@ -1,4 +1,6 @@
|
|||
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
|
||||
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Configure Proxy Access to the Internet
|
||||
<pre>╭─────── Caption ────────╮
|
||||
│ Variable <span style="color: #ffd700">Default value</span> │
|
||||
╰────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
|
||||
</pre>
|
||||
|
|
|
|||
|
|
@ -1,6 +0,0 @@
|
|||
<pre>╭─────── Caption ────────╮
|
||||
│ Variable <span style="color: #ffd700">Default value</span> │
|
||||
╰────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">null</span>
|
||||
</pre>
|
||||
|
|
@ -1,6 +1,7 @@
|
|||
<pre>╭──────── Caption ────────╮
|
||||
│ Variable Modified value │
|
||||
╰─────────────────────────╯
|
||||
<pre>╭────────────── Caption ───────────────╮
|
||||
│ Variable Modified value │
|
||||
│ (<span style="color: #00aa00">⏳ Original default value</span>) │
|
||||
╰──────────────────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML file "config/02/config.yml"
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML file "config/02/config.yml" (⏳ <span style="color: #00aa00">No proxy</span>)
|
||||
</pre>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<pre>╭──────── Caption ────────╮
|
||||
│ Variable Modified value │
|
||||
╰─────────────────────────╯
|
||||
<pre>╭────────────── Caption ───────────────╮
|
||||
│ Variable Modified value │
|
||||
│ (<span style="color: #00aa00">⏳ Original default value</span>) │
|
||||
╰──────────────────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: foo ◀ loaded from the YAML file "config/03/config.yml"
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: foo ◀ loaded from the YAML file "config/03/config.yml" (⏳ <span style="color: #00aa00">No proxy</span>)
|
||||
</pre>
|
||||
|
|
|
|||
|
|
@ -25,9 +25,9 @@
|
|||
</head>
|
||||
<body>
|
||||
<h1>Directory Tree</h1><p>
|
||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/./">.</a><br>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/./firefox/">firefox</a><br>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/./firefox/00-proxy.yml">00-proxy.yml</a><br>
|
||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_003/./">.</a><br>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_003/./firefox/">firefox</a><br>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_003/./firefox/00-proxy.yml">00-proxy.yml</a><br>
|
||||
<br><br><p>
|
||||
|
||||
2 directories, 1 file
|
||||
|
|
|
|||
Loading…
Reference in a new issue