From 28a89e6b2898c9e72af96e567a5f67c46d2bd0de Mon Sep 17 00:00:00 2001 From: gwen Date: Tue, 23 Jan 2024 10:57:01 +0100 Subject: [PATCH] typos --- docs/gettingstarted.rst | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/docs/gettingstarted.rst b/docs/gettingstarted.rst index 2853235b0..6cdf74c34 100644 --- a/docs/gettingstarted.rst +++ b/docs/gettingstarted.rst @@ -15,7 +15,7 @@ What is a consistency handling system ? Tiramisu - |Tiramisu| is a consistency handling system that was initially designed + |Tiramisu| is a consistency handling system that has initially been designed in the configuration management scope. To put it more simply, this library is generally used to handle configuration options. @@ -44,16 +44,16 @@ The dictionaries .. image:: images/schema.png -The main advantage is that declaring variables and writing consistency is a simple -as writing YAML. It is not necessary to write :term:`Tiramisu` code. +The main advantage is that declaring variables and writing consistency is as simple +as writing YAML. With Rougail it is not necessary to write :term:`Tiramisu` code any more. It simplifies a lot of things. -And rather than writing :term:`Tiramisu` code, we can declare variables and describe the relationships between variables in a declarative mode. +And rather than writing :term:`Tiramisu` code, we can declare variables and describe the relationships between variables in a declarative mode (that is, in a YAML file). Once the dictionaries are loaded by Rougail, we find all the power of the :term:`Tiramisu` configuration management tool. -The dictionaries YAML format ---------------------------------- +The YAML dictionaries format +----------------------------- Before getting started with Rougail we need to learn the specifics of the YAML dictionaries file format (as well as some templating concepts). @@ -78,14 +78,13 @@ The variables variable Here is a second definition of a :term:`variable`: it is a declaration unit that represents a business domain metaphor, - - the most common example is that a variable represents a configuration option + the most common example is that a variable that represents a configuration option in a application, but a variable represents something more that a configuration option. It provides a business domain specific representation unit. -.. note:: dictionaries can just define a list of variables, but we will see that +.. note:: Dictionaries can just define a list of variables, but we will see that we can specify a lot more. We can define variables **and** their relations, - and the consistency between them. + **and** the consistency between them. In the next step, we will explain through a tutorial how to construct a list of variables. @@ -176,7 +175,7 @@ Let's continuing on our "Hello world" theme and add a :term:`family` container. description: Somebody to say hello default: rougail -Here, we have a family named `world`. +Here, we have a family named `world`. This family contains a variable named `name` Again, let's validate this YAML file against Rougail's API: @@ -188,5 +187,5 @@ Again, let's validate this YAML file against Rougail's API: We then have the output: .. code-block:: python - + {'rougail.world.name': 'rougail'}