fix: mode
This commit is contained in:
parent
26362769ac
commit
abb0ec7063
4 changed files with 22 additions and 21 deletions
|
|
@ -228,15 +228,16 @@ The lifecycle of a variable includes the generic stages (for example, like in th
|
||||||
|
|
||||||
* - **User data**
|
* - **User data**
|
||||||
- Operator
|
- Operator
|
||||||
- - Access control
|
- - Reading
|
||||||
- Reading
|
|
||||||
- Assignment
|
- Assignment
|
||||||
|
- Access control
|
||||||
|
|
||||||
|
|
||||||
* - **Output**
|
* - **Output**
|
||||||
- - Operator
|
- - Operator
|
||||||
- Integrator
|
- Integrator
|
||||||
- - Access control
|
- - Reading
|
||||||
- Reading
|
- Access control
|
||||||
|
|
||||||
.. _variable_mutability:
|
.. _variable_mutability:
|
||||||
|
|
||||||
|
|
@ -281,16 +282,16 @@ Variable definition settings are immutable.
|
||||||
|
|
||||||
* - **User data**
|
* - **User data**
|
||||||
- Operator
|
- Operator
|
||||||
- - Access control
|
- - Reading
|
||||||
- Reading
|
|
||||||
- Assignment
|
- Assignment
|
||||||
|
- Access control
|
||||||
- Immutable
|
- Immutable
|
||||||
|
|
||||||
* - **Output**
|
* - **Output**
|
||||||
- - Operator
|
- - Operator
|
||||||
- Integrator
|
- Integrator
|
||||||
- - Access control
|
- - Reading
|
||||||
- Reading
|
- Access control
|
||||||
- Immutable
|
- Immutable
|
||||||
|
|
||||||
Value access
|
Value access
|
||||||
|
|
@ -329,16 +330,16 @@ The configuration is said to be in :term:`read only mode`.
|
||||||
|
|
||||||
* - **User data**
|
* - **User data**
|
||||||
- Operator
|
- Operator
|
||||||
- - Access control
|
- - Reading
|
||||||
- Reading
|
|
||||||
- Assignment
|
- Assignment
|
||||||
|
- Access control
|
||||||
- Immutable
|
- Immutable
|
||||||
- Read write
|
- Read write
|
||||||
|
|
||||||
* - **Output**
|
* - **Output**
|
||||||
- - Operator
|
- - Operator
|
||||||
- Integrator
|
- Integrator
|
||||||
- - Access control
|
- - Reading
|
||||||
- Reading
|
- Access control
|
||||||
- Immutable
|
- Immutable
|
||||||
- Read only
|
- Read only
|
||||||
|
|
|
||||||
|
|
@ -54,11 +54,11 @@ Modes
|
||||||
|
|
||||||
mode
|
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
|
Default mode for a family
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
|
||||||
|
|
@ -3,13 +3,13 @@ Mode
|
||||||
|
|
||||||
.. index:: 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 <mode>`.
|
||||||
|
|
||||||
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 <mode>` 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 <mode>`:
|
||||||
|
|
||||||
- `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.
|
- `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
|
- `standard`: automatically sets all other variables
|
||||||
|
|
|
||||||
|
|
@ -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"
|
description: if "_.provider" is not "Custom"
|
||||||
...
|
...
|
||||||
|
|
||||||
We had to enter :term:`user datas <user data>` 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
|
.. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_170/config/02/config.yml
|
||||||
:language: yaml
|
:language: yaml
|
||||||
|
|
@ -104,7 +104,7 @@ We had to enter :term:`user datas <user data>` of this new shape:
|
||||||
dns_over_https:
|
dns_over_https:
|
||||||
enable_dns_over_https: true
|
enable_dns_over_https: true
|
||||||
|
|
||||||
But now that we have defined a namespace, we need to populate our :term:`user datas <user data>` 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
|
.. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_180/config/01/config.yml
|
||||||
:language: yaml
|
:language: yaml
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue