diff --git a/docs/naming_convention.rst b/docs/naming_convention.rst index a2b895e00..3b0995e70 100644 --- a/docs/naming_convention.rst +++ b/docs/naming_convention.rst @@ -21,7 +21,7 @@ A file named :file:`firefox/00-proxy.yml` structure file and file named :file:`f ├── 00-proxy.yml └── 10-manual.yml -.. note:: We could of course could have put everything in one file. +.. note:: We of course could have put everything in one file. Again, it is better to separate the structures in different files for reasons of ordering and clarity. diff --git a/docs/tutorial/family.rst b/docs/tutorial/family.rst index 4178c387d..485189a64 100644 --- a/docs/tutorial/family.rst +++ b/docs/tutorial/family.rst @@ -113,7 +113,7 @@ Or a sub family A sub family is a family inside a family. -Creating a family hierarchy of family container types is very easy, here is an example: +Creating a family hierarchy of families (family inside a family) is very easy: .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_021/firefox/10-manual.yml :language: yaml @@ -132,7 +132,15 @@ Creating a family hierarchy of family container types is very easy, here is an e :tutorial:`Download this file from the rougail-tutorials git repository ` -Note that the `http_proxy` family lives inside the `manual` family. +Here in our use case we used the :term:`short-hand declaration mode ` +to declare our `manual` family: + +.. code-block:: yaml + + manual: # Manual proxy configuration + +And the `http_proxy` family lives inside of this `manual` family. +We therefore created a hierarchy of families. Putting a variable inside of a family or a sub family -----------------------------------------------------------