From abb0ec70639b1f5fe74d8c320db7a5d330c533d9 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Sat, 20 Jun 2026 10:32:36 +0200 Subject: [PATCH] fix: mode --- docs/abstract.rst | 25 +++++++++++++------------ docs/configuration.rst | 6 +++--- docs/structured_data/mode.rst | 8 ++++---- docs/tutorial/namespace.rst | 4 ++-- 4 files changed, 22 insertions(+), 21 deletions(-) diff --git a/docs/abstract.rst b/docs/abstract.rst index 4355349fd..410389dba 100644 --- a/docs/abstract.rst +++ b/docs/abstract.rst @@ -228,15 +228,16 @@ The lifecycle of a variable includes the generic stages (for example, like in th * - **User data** - Operator - - - Access control - - Reading + - - Reading - Assignment + - Access control + * - **Output** - - Operator - Integrator - - - Access control - - Reading + - - Reading + - Access control .. _variable_mutability: @@ -281,16 +282,16 @@ Variable definition settings are immutable. * - **User data** - Operator - - - Access control - - Reading + - - Reading - Assignment + - Access control - Immutable * - **Output** - - Operator - Integrator - - - Access control - - Reading + - - Reading + - Access control - Immutable Value access @@ -329,16 +330,16 @@ The configuration is said to be in :term:`read only mode`. * - **User data** - Operator - - - Access control - - Reading + - - Reading - Assignment + - Access control - Immutable - Read write * - **Output** - - Operator - Integrator - - - Access control - - Reading + - - Reading + - Access control - Immutable - Read only diff --git a/docs/configuration.rst b/docs/configuration.rst index 200226e88..ee6f724d6 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -54,11 +54,11 @@ Modes mode - modes are views on variables. + A mode is a solution that allows a variable or a family to be categorized. It can be used, for example, to define a level of expertise or a particular context. - Modes are customizable in Rougail. By default the modes are `basic`, `standard` and `advanced`. It is possible to change this list via the `modes_level` key. +Modes are customizable in Rougail. -If you change these values, consider changing the default modes of families and variables in your dictionaries. +Often, we categorize by level of expertise to access a variable: `basic`, `standard` and `advanced`. Default mode for a family ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/structured_data/mode.rst b/docs/structured_data/mode.rst index 9d65ab849..e108ecb8d 100644 --- a/docs/structured_data/mode.rst +++ b/docs/structured_data/mode.rst @@ -3,13 +3,13 @@ Mode .. index:: mode -By default, the mode is not configured. It is an optional feature. +By default, the :term:`mode` is not configured. It is an optional feature. -Let's start by defining what we want to do with the modes. +Let's start by defining what we want to do with the :term:`modes `. -We'll present a common example, but you'll need to define your own modes according to your needs. +We'll present a common example, but you'll need to define your own :term:`modes ` according to your needs. -Here is our classic use case of mode definition. We'll use three modes: +Here is our classic use case of :term:`mode` definition. We'll use three :term:`modes `: - `basic`: automatically sets mandatory variables without default values (in this case, the actor adapting the configuration will have to enter values) and manually sets variables that the actor defining the variables deems necessary. - `standard`: automatically sets all other variables diff --git a/docs/tutorial/namespace.rst b/docs/tutorial/namespace.rst index 432e1e7be..19cfce055 100644 --- a/docs/tutorial/namespace.rst +++ b/docs/tutorial/namespace.rst @@ -93,7 +93,7 @@ So far, to assign our :term:`user data` to a structure file like this one: description: if "_.provider" is not "Custom" ... -We had to enter :term:`user datas ` of this new shape: +We had to enter :term:`user data` of this new shape: .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_170/config/02/config.yml :language: yaml @@ -104,7 +104,7 @@ We had to enter :term:`user datas ` of this new shape: dns_over_https: enable_dns_over_https: true -But now that we have defined a namespace, we need to populate our :term:`user datas ` in this shape: +But now that we have defined a namespace, we need to populate our :term:`user data` in this shape: .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_180/config/01/config.yml :language: yaml