Resolve "doc: review"

Closes #8 (closed)

README-FR.md

@@ -8,7 +8,8 @@
 [![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](https://yunohost.org/#/) avec Ansible !
@@ -21,7+22,7 @@
 
 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.
 
 ### Installation de Yunohost
 
 ```yml
 # Script pour Debian 10 uniquement.
@@ -30,7+31,7 @@
 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_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.
 
 ### Gestion des domaines
@@ -38,52 +39,61 @@ ynh_admin_password: MYINSECUREPWD_PLZ_OVERRIDE_THIS
 ```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 permettra 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 ses sous-domaines optionnels et permettent d'installer une application par sous-domaine (plus d'infos [ici](https://yunohost.org/fr/dns_subdomains)).
+- `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
 
-```yml 
+```yml
 # Liste des utilisateurs Yunohost.
-ynh_users: 
+ynh_users:
    - name: user1
      pass: MYINSECUREPWD_PLZ_OVERRIDE_THIS
      firstname: Jane
-     lastname: Doe 
+     lastname: Doe
      mail_domain: domain.tld 
 ```
 
-Les utilisateurs sont créés à partir de la variable `ynh_users`. 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).
+- `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).
 
 ### Gestion des applications
 
 ```yml
 # Liste des applications Yunohost.
-ynh_apps: 
-  - label: WikiJS 
-    link: wikijs 
-    args: 
+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
 ```
 
-Les applications sont installées à partir de la variable `ynh_apps`. La variable `label` permet de donner un nom personnalisé à l'application sur l'interface utilisateur. `link` correspond au nom de l'application Yunohost qu'on souhaite installer. Concernant les arguments, `path` et `domain` sont indispensables. 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. 
+- `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