Resolve "doc: review"

Closes #8 (closed)

README-FR.md

@@ -8,63 +8,99 @@
 [![GitHub Release Date](https://img.shields.io/github/release-date/LydraFr/ansible-yunohost)](https://github.com/LydraFr/ansible-yunohost)
 [![GitHub Repo stars](https://img.shields.io/github/stars/LydraFr/ansible-yunohost?style=social)](https://github.com/LydraFr/ansible-yunohost)
 
-# ansible-yunohost
+# Rôle Ansible : Yunohost
+
 [🇬🇧 English version](README.md)
 
-Deployez Yunohost avec Ansible !
+Déployez [Yunohost](https://yunohost.org/#/) avec Ansible !
 
 ## Prérequis
 
 Aucun.
 
-## Role Variables
+## Variables du rôle
+
 Les variables par défaut sont disponibles dans `default/main.yml` cependant il est nécessaire de les surcharger selon vos besoins en termes de domaines, d'utilisateurs et d'applications sur Yunohost.
 
-## Exemple de Variables
+### Installation de Yunohost
+
 ```yml
----
-# Debian 10 script only.
+# Script pour Debian 10 uniquement.
 ynh_install_script_url: https://install.yunohost.org
 
 ynh_admin_password: MYINSECUREPWD_PLZ_OVERRIDE_THIS
+```
+
+-`ynh_install_script_url` est le script d'installation des packages Yunohost, par défaut c'est le script officiel. Yunohost ne s'installe que sur Debian 10.
+- `ynh_admin_password` est le mot de passe permettant d'accéder à l’interface d’administration du serveur.
 
-# The list of domains.
+### Gestion des domaines
+
+```yml
+# Liste des domaines gérés par Yunohost.
 ynh_main_domain: domain.tld
-ynh_extra_domains: 
+ynh_extra_domains:
   - forum.domain.tld
   - wiki.domain.tld
 ynh_ignore_dyndns_server: False
+```
+
+- `ynh_main_domain` correspond au domaine principal qui permet l’accès au serveur ainsi qu’au portail d’authentification des utilisateurs. On peut se contenter d'un nom de domaine qui nous appartient ou en utiliser un en .nohost.me / .noho.st / .ynh.fr (plus d'infos [ici](https://yunohost.org/fr/install/hardware:vps_debian)).
+- `ynh_extra_domains` sont des sous-domaines optionnels. Ils permettent d'installer une application par sous-domaine (plus d'infos [ici](https://yunohost.org/fr/dns_subdomains)).
+- `ynh_ignore_dyndns_server` permet d'enregistrer les domaines avec un service de DNS dynamique (plus d'infos [ici](https://yunohost.org/fr/dns_dynamicip)).
+
+### Gestion des utilisateurs
 
-# The list of Yunohost users.
-ynh_users: 
+```yml
+# Liste des utilisateurs Yunohost.
+ynh_users:
    - name: user1
      pass: MYINSECUREPWD_PLZ_OVERRIDE_THIS
      firstname: Jane
-     lastname: Doe 
+     lastname: Doe
      mail_domain: domain.tld 
+```
+
+- `ynh_users` est la liste des utilisateurs à créer. Chaque champ est obligatoire. Certaines applications Yunohost nécessitent qu'un utilisateur soit administrateur de l'application. Il aura ensuite le droit de gérer l'application depuis l'interface l'administration du serveur. Vous pouvez en apprendre plus sur la gestion des utilisateurs Yunohost [ici](https://yunohost.org/fr/administrate/overview/users).
 
-# The list of Yunohost apps.
-ynh_apps: 
-  - label: WikiJS # Label is important, it's a reference for the Playbook.
-    link: wikijs # It can be the name of an official app or a git repo link.
-    args: # Provide args. Domain and pah are mandatory, for other args read manifest.json of app.
+### Gestion des applications
+
+```yml
+# Liste des applications Yunohost.
+ynh_apps:
+  - label: WikiJS
+    link: wikijs
+    args:
       domain: wiki.domain.tld
       path: /
-      admin: user1 
+      admin: user1
       is_public: no
   - label: Discourse
-    link: discourse 
+    link: discourse
     args:
       domain: forum.domain.tld
       path: /
-      admin: user1 
+      admin: user1
       is_public: yes
 ```
+
+- `ynh_apps` est la liste des applications à installer.
+- `label` permet de donner un nom personnalisé à l'application sur l'interface utilisateur.
+- `link` correspond au nom de l'application Yunohost qu'on veut installer.
+
+Concernant les arguments :
+- `domain` est indispensable. Il faut choisir un des domaines de son instance Yunohost.
+- `path` est indispensable. Il faut choisir une URL pour accéder à son application comme `domain.tld/my_app`. Utilisez juste `/` si l'application doit s'installer sur un sous-domaine.
+- `is_public` est  un argument qu'on retrouve souvent. Paramétré sur `yes`, l'application sera accessible à tout le monde, même sans authentification sur le portail SSO Yunohost. Paramétré sur `no`, l'application ne sera accessible qu'après authentification.
+
+Pour les autres arguments, il faut se référer au `manifest.json` disponible dans le dépôt de l'application Yunohost qu'on installe. Vous pouvez en apprendre plus sur cette partie [ici](https://yunohost.org/fr/packaging_apps_manifest).
+
 ## Dépendances
 
 Aucune.
 
 ## Exemple de Playbook
+
 ```yml
 ---
 - name: Install Yunohost on Debian Server