typos and wrong urls
This commit is contained in:
parent
99394348b5
commit
4da1408c7f
1 changed files with 23 additions and 21 deletions
|
|
@ -12,7 +12,7 @@ Getting started
|
|||
.. prerequisites:: Prerequisites
|
||||
|
||||
- We assume that Rougail's library is :ref:`installed <installation>` on your computer.
|
||||
- If you want to follow with this tutorial with the help of the corresponding :tutorial:`Rougail-tutorials git repository <>`,
|
||||
- If you want to follow this tutorial with the help of the corresponding :tutorial:`Rougail-tutorials git repository <>`,
|
||||
this workshop page corresponds to the tags :tutorial:`v1.1_000 <src/tag/v1.1_000>` to :tutorial:`v1.1_011 <src/tag/v1.1_011>`
|
||||
in the repository:
|
||||
|
||||
|
|
@ -105,7 +105,7 @@ We can therefore deduce the fact that:
|
|||
Once defined, an option configuration :term:`value` is :term:`mandatory`.
|
||||
That is to say, it is absolutely necessary to assign a value to this variable.
|
||||
|
||||
Rougail waits for the `proxy_mode` configuration option's value to be set.
|
||||
Rougail expects the `proxy_mode` configuration option's value to be set.
|
||||
|
||||
.. glossary::
|
||||
|
||||
|
|
@ -194,19 +194,20 @@ Let's add a default value to this `proxy_mode` variable.
|
|||
|
||||
Now then how can I assign a normal value to a variable?
|
||||
|
||||
.. type-along:: The different rougail roles and the default values
|
||||
.. type-along:: The different rougail roles and setting a variable's value
|
||||
|
||||
So far we have only talked about the one that writes the :term:`structure files <structure file>`\ . It's *role* is called the integrator's role.
|
||||
So far we have only talked about the guy that writes the :term:`structure files <structure file>`\ .
|
||||
The one who writes the structure file plays the *role* of the *integrator*.
|
||||
|
||||
.. glossary::
|
||||
|
||||
integrator
|
||||
|
||||
An integrator in the Rougail field is the person who writes the :term:`structure files <structure file>`\ .
|
||||
He has the responsibilité of the integration process, that is,
|
||||
defines the variables and the relationship between them, the variables that are allowed
|
||||
He has the responsibility of the integration process, that is,
|
||||
he defines the variables and the relationship between them, the variables that are allowed
|
||||
(or not) to be set, and so on. His responsabilites are the **structuration** and the **consistency**
|
||||
of the variables.
|
||||
of the organisation of the variables beteen them.
|
||||
|
||||
Now we will talk about the one that defines the values. It is called the operator.
|
||||
|
||||
|
|
@ -217,11 +218,12 @@ Now we will talk about the one that defines the values. It is called the operato
|
|||
An operator in the Rougail field is the person who assigns :term:`value`\ s to the pre-defined variables,
|
||||
his responsabilities are to set variable values correctly.
|
||||
|
||||
The user :term:`value`\ s, that is the values that have been set by the operator, are of course type validated. The type validation is driven by the definitions in the :term:`structure file <structure file>`.
|
||||
The user :term:`value`\ s, that is the values that have been set by the operator, are of course type validated.
|
||||
The type validation is driven by the definitions in the :term:`structure file <structure file>`.
|
||||
|
||||
It is the operator's responsibility to set the user datas variables values.
|
||||
The operator does not handle the structure files,
|
||||
he is responsible of other files called the :term:`user data file`\ s.
|
||||
he is responsible of other files called the :term:`user data files <user data file>`.
|
||||
|
||||
.. glossary::
|
||||
|
||||
|
|
@ -232,44 +234,44 @@ he is responsible of other files called the :term:`user data file`\ s.
|
|||
|
||||
The variable's values are also called **user values**.
|
||||
|
||||
The consistency field is outside of the user datas scope.
|
||||
The consistency field is outside of the user datas scope.
|
||||
The consistency is handled in the :term:`structured datas <structured data>`\ 's scope.
|
||||
|
||||
.. important:: If user datas are not set, default values are mandatory, otherwise Rougail will raise an error.
|
||||
|
||||
.. exercise:: Folder structure update
|
||||
|
||||
Now we add a :file:`config/config.yaml` file in our project::
|
||||
Now we add a :file:`config/config.yml` file in our project::
|
||||
|
||||
rougail-tutorials
|
||||
├── firefox
|
||||
│ ├── 00-proxy.yml
|
||||
│ ├── 00-proxy.yml
|
||||
└── config
|
||||
└── config.yaml
|
||||
└── config.yml
|
||||
|
||||
.. type-along:: how to set a value in a user datas file
|
||||
|
||||
So for example if the integrator has not set any default value in his structure file,
|
||||
it's up to the operator to do the job in the `config.yaml` file:
|
||||
it's up to the operator to do the job in the `config.yml` file:
|
||||
|
||||
.. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_003/config/02/config.yml
|
||||
:language: yaml
|
||||
:caption: A Rougail user datas file :file:`config/config.yaml`, with a default value set.
|
||||
:caption: A Rougail user datas file :file:`config/config.yml`, with a default value set.
|
||||
:name: RougailConfigDefaultValue
|
||||
|
||||
..
|
||||
---
|
||||
proxy_mode: No proxy
|
||||
|
||||
:tutorial:`Download this file from the rougail-tutorials git repository <src/tag/v1.1_001/config/02/config.yaml>`
|
||||
:tutorial:`Download this file from the rougail-tutorials git repository <src/tag/v1.1_001/config/02/config.yml>`
|
||||
|
||||
With the rougail CLI the operator has to add the `-u yaml -ff config/config.yaml` options:
|
||||
With the rougail CLI the operator has to add the `-u yaml -ff config/config.yml` options:
|
||||
|
||||
.. code-block:: text
|
||||
:class: terminal
|
||||
:caption: A rougail Command Line Utility call with the :file:`config/config.yaml` Rougail user datas file
|
||||
:caption: A rougail Command Line Utility call with the :file:`config/config.yml` Rougail user datas file
|
||||
|
||||
rougail -m firefox -u yaml -ff config/02/config.yaml
|
||||
rougail -m firefox -u yaml -ff config/02/config.yml
|
||||
|
||||
which gives us this output:
|
||||
|
||||
|
|
@ -282,7 +284,7 @@ which gives us this output:
|
|||
│ Variable Modified value │
|
||||
╰─────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: No proxy ◀ loaded from the YAML file "config/02/config.yaml"
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: No proxy ◀ loaded from the YAML file "config/02/config.yml"
|
||||
</pre>
|
||||
|
||||
.. admonition:: Important fact
|
||||
|
|
@ -363,7 +365,7 @@ If we run the rougail CLI with this user datas, we have:
|
|||
.. code-block:: text
|
||||
:class: terminal
|
||||
|
||||
rougail -m firefox -u yaml -ff config/03/config.yaml
|
||||
rougail -m firefox -u yaml -ff config/03/config.yml
|
||||
|
||||
We have this output:
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue