From f3c3fe4df0b8c6489944062ee24cba610757762f Mon Sep 17 00:00:00 2001 From: gwen Date: Wed, 5 Nov 2025 17:34:12 +0100 Subject: [PATCH] typo --- docs/gettingstarted.rst | 32 -------------------------------- docs/index.rst | 12 ++---------- docs/library/tags.rst | 1 + docs/tutorial/preliminary.rst | 4 ++-- 4 files changed, 5 insertions(+), 44 deletions(-) diff --git a/docs/gettingstarted.rst b/docs/gettingstarted.rst index a673f9402..206121bc3 100644 --- a/docs/gettingstarted.rst +++ b/docs/gettingstarted.rst @@ -1,35 +1,3 @@ -Getting started -==================== - -What is a consistency handling system ? ------------------------------------------------- - -.. questions:: Rougail, Tiramisu: What is it all about? - - **Question**: OK, I have understood that the Rougail library allows me to take advantage of the :xref:`tiramisu` consistency handling library. But what is all this for? What is exactly a consistency handling system? And again, what is this :xref:`Tiramisu library ` used for? - - **Answer**: Well, we will explain in details what this :xref:`tiramisu` library is and what Rougail is. - - In (very) short: - - - Rougail is the YAML consistency description of a :term:`context`\ 's situation - - Tiramisu is the consistency engine linter - -.. glossary:: - - Tiramisu - - :xref:`tiramisu` is a consistency handling system that has initially been designed - in the configuration management scope. Until now, - this library is generally used to handle configuration options. - - It manages variables and group of variables. In the Tiramisu scope we call - it *options* and *option descriptions*. - - Here is the :xref:`tiramisu documentation `. - -In the Rougail scope, we call it :term:`variables ` and :term:`families `. -In Rougail, the families and variables are located in the :term:`structure files `. The structure files --------------------- diff --git a/docs/index.rst b/docs/index.rst index b4bcb56ab..399930eeb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -34,19 +34,11 @@ Rougail - it is also a `Python `_ library which enables us to conveniently load application :term:`variable`\ s in a simple `YAML `_ format in such a way that the end user consumer can handle them consistently (that is, against an user-defined consistency). -In other words, using Rougail in your application or your python libraries can tansform end user consumer defined consistency rules into highly consistent business objects. - -We then have to say that the handling system used to ensure the variables integrity is another python library, called :term:`Tiramisu`. Rougail is currently strongly affiliated with Tiramisu. - -.. note:: Rougail is currently intended to work in coordination with :term:`Tiramisu` and **is not** intended to be connected with any other consistency handling system. - -Explained differently, Rougail allows you to easily implement an integration of the powerful tiramisu consistency handling system. - .. toctree:: :titlesonly: - :caption: Getting started + :caption: What is it all about - gettingstarted + concepts tutorial/index .. toctree:: diff --git a/docs/library/tags.rst b/docs/library/tags.rst index ce3f4ed29..522d6f8f2 100644 --- a/docs/library/tags.rst +++ b/docs/library/tags.rst @@ -106,6 +106,7 @@ Here is a smal script that walk that the configuration and "print" option with " Let's execute `script.py`: .. code-block:: bash + $ python3 script.py server1.internal_domain (Server domaine name) server2.address (Server domaine name) diff --git a/docs/tutorial/preliminary.rst b/docs/tutorial/preliminary.rst index 3888be80c..37a6bc5fc 100644 --- a/docs/tutorial/preliminary.rst +++ b/docs/tutorial/preliminary.rst @@ -1,5 +1,5 @@ -Preliminaries -================ +Getting started +==================== .. objectives:: Objectives