doc: leadership => sequence
This commit is contained in:
parent
2508087841
commit
53c3cf316f
4 changed files with 8 additions and 10 deletions
|
|
@ -132,7 +132,7 @@ Generate documentation from structural files
|
|||
**Environment variable**: ROUGAILCLI_DOC.DEFAULT_VALUES
|
||||
- Modify values to document all variables.
|
||||
|
||||
To document leadership or dynamic family variables, it is sometimes necessary to generate values, which can change the values in the configuration. Be careful if you reuse this configuration.
|
||||
To document homogeneous elements type or dynamic family variables, it is sometimes necessary to generate values, which can change the values in the configuration. Be careful if you reuse this configuration.
|
||||
|
||||
**Default**: true
|
||||
|
||||
|
|
|
|||
|
|
@ -364,7 +364,7 @@ An example with an index type parameter:
|
|||
---
|
||||
version: '1.1'
|
||||
family:
|
||||
type: leadership
|
||||
type: sequence
|
||||
leader:
|
||||
multi: true
|
||||
default:
|
||||
|
|
@ -540,7 +540,7 @@ Calculation via an index
|
|||
---
|
||||
version: '1.1'
|
||||
family:
|
||||
type: leadership
|
||||
type: sequence
|
||||
leader:
|
||||
multi: true
|
||||
default:
|
||||
|
|
|
|||
|
|
@ -223,7 +223,7 @@ An example with an index type parameter:
|
|||
---
|
||||
version: 1.1
|
||||
family:
|
||||
type: leadership
|
||||
type: sequence
|
||||
leader:
|
||||
multi: true
|
||||
default:
|
||||
|
|
|
|||
|
|
@ -33,14 +33,12 @@ Name and parameter conflict
|
|||
|
||||
.. type-along:: Let's recap how far we've come
|
||||
|
||||
FIXME: changer le nom leadership
|
||||
|
||||
We have this leadership family in its structure definition file:
|
||||
We have this homogeneous elements type family in its structure definition file:
|
||||
|
||||
.. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_202/foxyproxy/00-foxyproxy.yml
|
||||
:linenos:
|
||||
:language: yaml
|
||||
:caption: The `proxies` family with `leadership` type in the :file:`foxyproxy/00-foxyproxy.yml` structure file
|
||||
:caption: The `proxies` family with `sequence` type in the :file:`foxyproxy/00-foxyproxy.yml` structure file
|
||||
|
||||
The variable "type" that conflits with the family parameter "type"
|
||||
----------------------------------------------------------------------------
|
||||
|
|
@ -49,7 +47,7 @@ Choice a good variable name is important. It's with this name that user will int
|
|||
|
||||
The user has to define the type of the new proxy. So instinctively the name of the variable will be `type`.
|
||||
|
||||
But in the current family we have already the parameter `type` with the `leadership` value.
|
||||
But in the current family we have already the parameter `type` with the `sequence` value.
|
||||
YAML do not permit to have two key with the same name.
|
||||
Maybe we could choice an other variable name like `proxy_type` but the full path will be `proxies.proxy_type`.
|
||||
Repeating the word proxy is not appropriate.
|
||||
|
|
@ -60,7 +58,7 @@ Let's create a family named `manual` which obviously corresponds to the proxy's
|
|||
|
||||
.. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_210/foxyproxy/00-foxyproxy.yml
|
||||
:language: yaml
|
||||
:caption: The `proxies` family with `leadership` type and a variable with the name `type` in the :file:`foxyproxy/00-foxyproxy.yml` structure file
|
||||
:caption: The `proxies` family with `sequence` type and a variable with the name `type` in the :file:`foxyproxy/00-foxyproxy.yml` structure file
|
||||
|
||||
Technically it's possible to put `_` at the beginning of each parameter name, but it's still less readable.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue