diff --git a/docs/tutorial/domainname.rst b/docs/tutorial/domainname.rst index bbd7b1f99..38d51a54d 100644 --- a/docs/tutorial/domainname.rst +++ b/docs/tutorial/domainname.rst @@ -45,7 +45,7 @@ We have an `http_proxy` family with an `address` variable in it. A variable with type `domainname` ----------------------------------- -We will add a custom type to our `address` variable: +We will add a business types to our `address` variable: .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_030/firefox/10-manual.yml :language: yaml @@ -60,18 +60,10 @@ We will add a custom type to our `address` variable: :tutorial:`Download this file from the rougail-tutorials git repository ` -Notice that we have assigned the `domainname` type to this variable: - -.. code-block:: yaml - :linenos: - :caption: The `address` variable with the `domainname` type assigned - - address: - type: domainname - +Notice that with this `type: domainname` we have assigned the `domainname` business type to this variable. Assigning a type is convenient for reading, but what else does it bring? -Well, with a correct user data like this one, +Well, with a correct user data like this one: .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_030/config/01/config.yml :language: yaml @@ -155,7 +147,10 @@ we then have this output: ignored when loading from the YAML file "config/02/config.yml" -.. type-along:: what if we set an IP address instead of a domain name? +A variable with type's parameters +------------------------------------- + +What if we set an IP address instead of a domain name? .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_030/config/02/config.yml :language: yaml @@ -207,9 +202,6 @@ Well, it is possible to configure the type so that it accepts IP addresses. We need to specify whether our variable accepts to be filled using an IP or a domain name only. This is where the ability to parameterize our variable comes in. -A variable with type's parameters -------------------------------------- - .. type-along:: For those who follow the tutorial with the help of the git repository Now you need to checkout the `v1.1_031` version:: @@ -422,7 +414,8 @@ Let's add one more variable in the `manual` family, with a much more basic type: Note that if two different structure files are loaded by Rougail and if they declare the same family name, then **the declarations are concatenated in the family name**. -Let's switch this boolean variable to a `false` value: +Let's switch this boolean variable to a `false` value, to do this we will add +this :file:`config/02/config.yml` user data file in the :term:`configuration`: .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_033/config/02/config.yml :language: yaml diff --git a/docs/tutorial/family.rst b/docs/tutorial/family.rst index 0895a1d90..ae7ca01f8 100644 --- a/docs/tutorial/family.rst +++ b/docs/tutorial/family.rst @@ -257,40 +257,6 @@ Let's recap about the user datas. We can see in this Rougail CLI output that: - the `proxy_mode` value is set by default by the :term:`integrator` - the `address` value is has been set by an :term:`operator` -.. type-along:: A `port` variable in the `http_proxy` family - -Now let's add a `port` variable in the `http_proxy` family: - -.. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_022/config/03/config.yml - :language: yaml - :caption: The :file:`config/03/config.yml` user data file with the `port` number added - :linenos: - -.. - --- - manual: - description: Manual proxy configuration - - http_proxy: - description: HTTP Proxy - - address: - description: HTTP address - type: domainname - - port: - description: HTTP Port - default: 8080 - -:tutorial:`Download this file from the rougail-tutorials git repository ` - -In short: - -.. confval:: port - :default: 8080 - - The HTTP Port - .. keypoints:: let's review the key points **Keywords**