From 8e60f97be0cf20d12ebb71059663d380d9866b0a Mon Sep 17 00:00:00 2001
From: Emmanuel Garette <egarette@silique.fr>
Date: Thu, 10 Aug 2023 10:15:12 +0200
Subject: [PATCH] update openldap documentations

---
 seed/openldap/README.md                      | 32 ++++++++++----------
 seed/openldap/extras/accounts/00_account.xml | 30 +++++++++---------
 2 files changed, 31 insertions(+), 31 deletions(-)

diff --git a/seed/openldap/README.md b/seed/openldap/README.md
index 61eafc00..45a29c02 100644
--- a/seed/openldap/README.md
+++ b/seed/openldap/README.md
@@ -9,7 +9,7 @@ include_toc: true
 
 OpenLDAP, the LDAP server.
 
-[More informations about this software.](https://www.openldap.org/)
+[Software's website.](https://www.openldap.org/)
 
 This service provides a LDAP server.
 
@@ -27,29 +27,29 @@ Other services may also require automatic user creation.
 
 ### Accounts
 
-#### Gestion des utilisateurs
+#### Users management
 
-This a family is a leadership.
+Management of manually created local users. Those users are not classified.. This family is a leadership.
 
-| Parameter                                                                                                                                                                                                                  | Comments                                                         |
-|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------|
-| **[accounts.users.ldap_user_mail](extras/accounts/00_account.xml)**<br/>multiple<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable)      | Adresse courriel du compte.<br/>**Example:** johndoe@example.net |
-| **[accounts.users.ldap_user_aliases](extras/accounts/00_account.xml)**<br/>multiple<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable)   | Aliases du mail.                                                 |
-| **[accounts.users.ldap_user_uid](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Nom de compte.<br/>**Example:** jdoe                             |
-| **[accounts.users.ldap_user_sn](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable)     | Prénom.<br/>**Example:** John                                    |
-| **[accounts.users.ldap_user_gn](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable)     | Nom de famille.<br/>**Example:** Doe                             |
+| Parameter                                                                                                                                                                                                                  | Comments                                                                                           |
+|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
+| **[accounts.users.ldap_user_mail](extras/accounts/00_account.xml)**<br/>multiple<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable)      | Email address.<br/>An user is identify by his email address..<br/>**Example:** johndoe@example.net |
+| **[accounts.users.ldap_user_aliases](extras/accounts/00_account.xml)**<br/>multiple<br/>**Type:** [`mail`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable)   | Emails aliases.<br/>**Example:** jdoe@example.net                                                  |
+| **[accounts.users.ldap_user_uid](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Account name.<br/>**Example:** jdoe                                                                |
+| **[accounts.users.ldap_user_gn](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable)     | Given Name.<br/>**Example:** John                                                                  |
+| **[accounts.users.ldap_user_sn](extras/accounts/00_account.xml)**<br/>mandatory<br/>**Type:** [`string`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable)     | Surname.<br/>**Example:** Doe                                                                      |
 
-| Parameter                                                                                                                                                                                                      | Comments   |
-|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|
-| **[accounts.families](extras/accounts/00_account.xml)**<br/>multiple<br/>**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Familles.  |
+| Parameter                                                                                                                                                                                                      | Comments                                                                                                                            |
+|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
+| **[accounts.families](extras/accounts/00_account.xml)**<br/>multiple<br/>**Type:** [`unix_user`](https://forge.cloud.silique.fr/risotto/rougail/src/branch/main/doc/variable/README.md#le-type-de-la-variable) | Familles to create.<br/>Users can be classified into families. This variable contains all the names of the families to be created.. |
 
-#### Gestion de la famille 
+#### Management of family 
 
-This a dynamic family generated from the variable "accounts.families".
+Management of manually created users. Those users an classified in a family.. This a dynamic family generated from the variable "accounts.families".
 
 ##### Gestion des utilisateurs de la famille 
 
-This a family is a leadership.
+This family is a leadership.
 
 | Parameter                                                                                                                                                                                                                            | Comments                                   |
 |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|
diff --git a/seed/openldap/extras/accounts/00_account.xml b/seed/openldap/extras/accounts/00_account.xml
index 5aed681b..f7e2b205 100644
--- a/seed/openldap/extras/accounts/00_account.xml
+++ b/seed/openldap/extras/accounts/00_account.xml
@@ -1,23 +1,23 @@
 <?xml version='1.0' encoding='UTF-8'?>
 <rougail version="0.10">
   <variables>
-    <variable name="remotes" description="Serveurs distant ayant un compte" type="domainname" multi="True" provider="LDAP"/>
-    <family name="remote_" description="Compte LDAP pour " dynamic="accounts.remotes">
-      <variable name="family_" description="Nom de la familly de " hidden="True" provider="LDAP:family"/>
-      <variable name="dn_" description="LDAP DN de " hidden="True" provider="LDAP:dn"/>
-      <variable name="password_" type ="password" description="Mot de passe de " hidden="True" provider="LDAP:password"/>
-      <variable name="base_dn_" description="LDAP base DN de " hidden="True" provider="LDAP:base_dn"/>
+    <variable name="remotes" description="Remote services with an account" type="domainname" multi="True" provider="LDAP"/>
+    <family name="remote_" dynamic="accounts.remotes" hidden="True">
+      <variable name="family_" provider="LDAP:family"/>
+      <variable name="dn_" provider="LDAP:dn"/>
+      <variable name="password_" type="password" provider="LDAP:password"/>
+      <variable name="base_dn_" provider="LDAP:base_dn"/>
     </family>
-    <family name="users" description="Gestion des utilisateurs" leadership="True">
-      <variable name='ldap_user_mail' type="mail" description="Adresse courriel du compte" multi="True" test="johndoe@example.net"/>
-      <variable name='ldap_user_aliases' type="mail" description="Aliases du mail" multi="True"/>
-      <variable name='ldap_user_uid' type="unix_user" description="Nom de compte" mandatory="True" test="jdoe"/>
-      <variable name='ldap_user_sn' type="string" description="Prénom" mandatory="True" test="John"/>
-      <variable name='ldap_user_gn' type="string" description="Nom de famille" mandatory="True" test="Doe"/>
-      <variable name='ldap_user_password' type="password" description="Mot de passe" mandatory="True" hidden="True"/>
+    <family name="users" description="Users management" leadership="True" help="Management of manually created local users. Those users are not classified.">
+      <variable name='ldap_user_mail' type="mail" description="Email address" multi="True" test="johndoe@example.net" help="An user is identify by his email address."/>
+      <variable name='ldap_user_aliases' type="mail" description="Emails aliases" multi="True" test="jdoe@example.net"/>
+      <variable name='ldap_user_uid' type="unix_user" description="Account name" mandatory="True" test="jdoe"/>
+      <variable name='ldap_user_gn' type="string" description="Given Name" mandatory="True" test="John"/>
+      <variable name='ldap_user_sn' type="string" description="Surname" mandatory="True" test="Doe"/>
+      <variable name='ldap_user_password' type="password" mandatory="True" hidden="True"/>
     </family>
-    <variable name="families" description="Familles" type="unix_user" multi="True"/>
-    <family name="family_" description="Gestion de la famille " dynamic="accounts.families">
+    <variable name="families" description="Familles to create" type="unix_user" multi="True" help="Users can be classified into families. This variable contains all the names of the families to be created."/>
+    <family name="family_" description="Management of family " dynamic="accounts.families" help="Management of manually created users. Those users an classified in a family.">
       <family name="users_" description="Gestion des utilisateurs de la famille " leadership="True">
         <variable name='ldap_user_mail_' type="mail" description="Adresse courriel du compte de la famille " multi="True"/>
         <variable name='ldap_user_aliases_' type="mail" description="Aliases du mail de la famille " multi="True"/>