Pour tout problème contactez-nous par mail : support@froggit.fr | La FAQ :grey_question: | Rejoignez-nous sur le Chat :speech_balloon:

Skip to content
Snippets Groups Projects
Commit c170aff7 authored by Arthur BOUDREAULT's avatar Arthur BOUDREAULT
Browse files

docs: apply Christophe suggestions for YAML syntax

parent d4310781
No related branches found
No related tags found
No related merge requests found
Pipeline #5500 passed with warnings
Stage: info
    Stage: lint
      Hide whitespace changes
      Inline Side-by-side
      README-FR.md
      + 4
      − 10
      View file @ c170aff7
      ...@@ -8,7 +8,7 @@ ...@@ -8,7 +8,7 @@
      [![GitHub Release Date](https://img.shields.io/github/release-date/LydraFr/ansible-yunohost)](https://github.com/LydraFr/ansible-yunohost) [![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) [![GitHub Repo stars](https://img.shields.io/github/stars/LydraFr/ansible-yunohost?style=social)](https://github.com/LydraFr/ansible-yunohost)
      Collection Ansible - lydra.yunohost Collection Ansible - `lydra.yunohost`
      [🇬🇧 English version](README.md) [🇬🇧 English version](README.md)
      ...@@ -17,22 +17,18 @@ Comme il s'agit d'une collection indépendante, elle peut être publiée selon s ...@@ -17,22 +17,18 @@ Comme il s'agit d'une collection indépendante, elle peut être publiée selon s
      ## Prérequis ## Prérequis
      ------------
      Votre serveur doit être basé sur du Debian Buster et Yunohost ne doit pas déjà être installé. Votre serveur doit être basé sur du Debian Buster et Yunohost ne doit pas déjà être installé.
      ## Contenu de la collection ## Contenu de la collection
      ### Rôles ### Rôles
      - [`lydra.yunohost.ynh_setup`](roles/ynh_setup/README-FR.md) : Ce rôle prépare les serveurs à base de Debian-Buster à exécuter Yunohost. Il configure Yunohost avec ses paramètres initiaux et les domaines, utilisateurs et applications de votre choix. - [`lydra.yunohost.ynh_setup`](roles/ynh_setup/README-FR.md) : Ce rôle prépare les serveurs à base de Debian-Buster à exécuter Yunohost. Il configure Yunohost avec ses paramètres initiaux, les domaines et les utilisateurs de votre choix.
      - [`lydra.yunohost.ynh_apps`](roles/ynh_apps/README-FR.md): Ce rôle installe les applications Yunohost de votre choix et peut également lancer des tâches de post-installation. - [`lydra.yunohost.ynh_apps`](roles/ynh_apps/README-FR.md): Ce rôle installe les applications Yunohost de votre choix et peut également les configurer grâce aux tâches de post-installation.
      - [`lydra.yunohost.ynh_config`](roles/ynh_config/README-FR.md) : Ce rôle gère la configuration de différents services de Yunohost (relais SMTP, mises à jour automatiques). - [`lydra.yunohost.ynh_config`](roles/ynh_config/README-FR.md) : Ce rôle gère la configuration de différents services de Yunohost (relais SMTP, mises à jour automatiques).
      - [`lydra.yunohost.ynh_backup`](roles/ynh_backup/README-FR.md) : Ce rôle gère la configuration des sauvegardes. - [`lydra.yunohost.ynh_backup`](roles/ynh_backup/README-FR.md) : Ce rôle gère la configuration des sauvegardes.
      ### lydra.yunohost Tags du rôle ### Tags du rôle
      ------------
      Ces tags sont applicables suivant les rôles. Ces tags sont applicables suivant les rôles.
      ...@@ -50,8 +46,6 @@ Ces tags sont applicables suivant les rôles. ...@@ -50,8 +46,6 @@ Ces tags sont applicables suivant les rôles.
      ## License ## License
      ------------
      [![ansible-yunohost Copyright 2021 Lydra](https://www.gnu.org/graphics/gplv3-with-text-136x68.png)](https://choosealicense.com/licenses/gpl-3.0/) [![ansible-yunohost Copyright 2021 Lydra](https://www.gnu.org/graphics/gplv3-with-text-136x68.png)](https://choosealicense.com/licenses/gpl-3.0/)
      **ansible-yunohost** est maintenu par [Lydra](https://lydra.fr/) et publié sous la licence GPL3. **ansible-yunohost** est maintenu par [Lydra](https://lydra.fr/) et publié sous la licence GPL3.
      README.md
      + 2
      − 8
      View file @ c170aff7
      ...@@ -8,7 +8,7 @@ ...@@ -8,7 +8,7 @@
      [![GitHub Release Date](https://img.shields.io/github/release-date/LydraFr/ansible-yunohost)](https://github.com/LydraFr/ansible-yunohost) [![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) [![GitHub Repo stars](https://img.shields.io/github/stars/LydraFr/ansible-yunohost?style=social)](https://github.com/LydraFr/ansible-yunohost)
      # Ansible Collection - lydra.yunohost # Ansible Collection - `lydra.yunohost`
      [🇫🇷 French version](README-FR.md) [🇫🇷 French version](README-FR.md)
      ...@@ -17,8 +17,6 @@ As this is an independent collection, it can be released on its own release cade ...@@ -17,8 +17,6 @@ As this is an independent collection, it can be released on its own release cade
      # Prerequisites # Prerequisites
      ------------
      Your server must be Debian-Buster based and Yunohost shouldn't be already installed. Your server must be Debian-Buster based and Yunohost shouldn't be already installed.
      ## Collection contents ## Collection contents
      ...@@ -30,9 +28,7 @@ Your server must be Debian-Buster based and Yunohost shouldn't be already instal ...@@ -30,9 +28,7 @@ Your server must be Debian-Buster based and Yunohost shouldn't be already instal
      - [`lydra.yunohost.ynh_config`](roles/ynh_config/README.md): This role configures various Yunohost services (SMTP relay, auto updates). - [`lydra.yunohost.ynh_config`](roles/ynh_config/README.md): This role configures various Yunohost services (SMTP relay, auto updates).
      - [`lydra.yunohost.ynh_backup`](roles/ynh_backup/README.md): This role manages the configuration of backups. - [`lydra.yunohost.ynh_backup`](roles/ynh_backup/README.md): This role manages the configuration of backups.
      ## lydra.yunohost Role Tags ## Role Tags
      ------------
      These tags are applicable to roles. These tags are applicable to roles.
      ...@@ -50,8 +46,6 @@ These tags are applicable to roles. ...@@ -50,8 +46,6 @@ These tags are applicable to roles.
      ## License ## License
      ------------
      [![ansible-yunohost Copyright 2021 Lydra](https://www.gnu.org/graphics/gplv3-with-text-136x68.png)](https://choosealicense.com/licenses/gpl-3.0/) [![ansible-yunohost Copyright 2021 Lydra](https://www.gnu.org/graphics/gplv3-with-text-136x68.png)](https://choosealicense.com/licenses/gpl-3.0/)
      **ansible-yunohost** is maintained by [Lydra](https://lydra.fr/) and released under the GPL3 license. **ansible-yunohost** is maintained by [Lydra](https://lydra.fr/) and released under the GPL3 license.
      roles/ynh_backup/README-FR.md
      + 0
      − 12
      View file @ c170aff7
      ...@@ -6,20 +6,14 @@ Sauvegardez [Yunohost](https://yunohost.org/#/) avec Ansible ! ...@@ -6,20 +6,14 @@ Sauvegardez [Yunohost](https://yunohost.org/#/) avec Ansible !
      ## Prérequis ## Prérequis
      ------------
      Yunohost doit déjà être installé sur votre serveur. Yunohost doit déjà être installé sur votre serveur.
      ## Variables du rôle ## Variables du rôle
      ------------
      Les variables par défaut sont disponibles dans `default/main.yml` cependant il est possible de les surcharger selon vos besoins en ... Les variables par défaut sont disponibles dans `default/main.yml` cependant il est possible de les surcharger selon vos besoins en ...
      ### Gestion des sauvegardes ### Gestion des sauvegardes
      ------------
      ```yml ```yml
      ynh_backup: ynh_backup:
      scheduled: True scheduled: True
      ...@@ -46,14 +40,10 @@ La tâche backup va permettre de sauvegarder les applications Yunohost ainsi que ...@@ -46,14 +40,10 @@ La tâche backup va permettre de sauvegarder les applications Yunohost ainsi que
      ## Dépendances ## Dépendances
      ------------
      Aucune. Aucune.
      ## Exemple de Playbook ## Exemple de Playbook
      ------------
      ```yml ```yml
      --- ---
      - name: Configure Yunohost backups - name: Configure Yunohost backups
      ...@@ -67,8 +57,6 @@ Aucune. ...@@ -67,8 +57,6 @@ Aucune.
      ## License ## License
      ------------
      [![ansible-yunohost Copyright 2021 Lydra](https://www.gnu.org/graphics/gplv3-with-text-136x68.png)](https://choosealicense.com/licenses/gpl-3.0/) [![ansible-yunohost Copyright 2021 Lydra](https://www.gnu.org/graphics/gplv3-with-text-136x68.png)](https://choosealicense.com/licenses/gpl-3.0/)
      **ansible-yunohost** est maintenu par [Lydra](https://lydra.fr/) et publié sous la licence GPL3. **ansible-yunohost** est maintenu par [Lydra](https://lydra.fr/) et publié sous la licence GPL3.
      roles/ynh_backup/README.md
      + 0
      − 12
      View file @ c170aff7
      ...@@ -6,20 +6,14 @@ Deploy [Yunohost](https://yunohost.org/#/) with Ansible! ...@@ -6,20 +6,14 @@ Deploy [Yunohost](https://yunohost.org/#/) with Ansible!
      ## Requirements ## Requirements
      ------------
      Yunohost needs to be installed on your server. Yunohost needs to be installed on your server.
      ## Role Variables ## Role Variables
      ------------
      Default variables are available in `default/main.yml` however it is necessary to override them according to your needs for ... Default variables are available in `default/main.yml` however it is necessary to override them according to your needs for ...
      ### Backups management ### Backups management
      ------------
      ```yml ```yml
      ynh_backup: ynh_backup:
      scheduled: True scheduled: True
      ...@@ -46,14 +40,10 @@ The backup task will allow to backup Yunohost applications and their data by set ...@@ -46,14 +40,10 @@ The backup task will allow to backup Yunohost applications and their data by set
      ## Dependencies ## Dependencies
      ------------
      None. None.
      ## Example Playbook ## Example Playbook
      ------------
      ```yml ```yml
      --- ---
      - name: Configure Yunohost backups - name: Configure Yunohost backups
      ...@@ -67,8 +57,6 @@ None. ...@@ -67,8 +57,6 @@ None.
      ## License ## License
      ------------
      [![ansible-yunohost Copyright 2021 Lydra](https://www.gnu.org/graphics/gplv3-with-text-136x68.png)](https://choosealicense.com/licenses/gpl-3.0/) [![ansible-yunohost Copyright 2021 Lydra](https://www.gnu.org/graphics/gplv3-with-text-136x68.png)](https://choosealicense.com/licenses/gpl-3.0/)
      **ansible-yunohost** is maintained by [Lydra](https://lydra.fr/) and released under the GPL3 license. **ansible-yunohost** is maintained by [Lydra](https://lydra.fr/) and released under the GPL3 license.
      roles/ynh_backup/tasks/backup.yml
      + 1
      − 1
      View file @ c170aff7
      ...@@ -37,7 +37,7 @@ ...@@ -37,7 +37,7 @@
      - backup - backup
      - cron - cron
      - name: Create cron task to perform YNH backup - name: Create cron task to schedule YNH backup script
      ansible.builtin.cron: ansible.builtin.cron:
      name: "auto-backup to {{ ynh_backup.directory | default('/home/yunohost.backup/archives') }}" name: "auto-backup to {{ ynh_backup.directory | default('/home/yunohost.backup/archives') }}"
      month: "{{ ynh_backup.scheduled_month | default('*') }}" month: "{{ ynh_backup.scheduled_month | default('*') }}"
      ......
      roles/ynh_config/README-FR.md
      + 0
      − 12
      View file @ c170aff7
      ...@@ -10,14 +10,10 @@ Yunohost doit déjà être installé sur votre serveur. ...@@ -10,14 +10,10 @@ Yunohost doit déjà être installé sur votre serveur.
      ## Variables du rôle ## Variables du rôle
      ------------
      Les variables par défaut sont disponibles dans `default/main.yml` cependant il est possible de les surcharger selon vos besoins. Les variables par défaut sont disponibles dans `default/main.yml` cependant il est possible de les surcharger selon vos besoins.
      ### Configuration d'un relais SMTP ### Configuration d'un relais SMTP
      ------------
      ```yml ```yml
      # paramètres personnalisés du relais SMTP # paramètres personnalisés du relais SMTP
      ynh_smtp_relay: ynh_smtp_relay:
      ...@@ -32,8 +28,6 @@ Pour faire cela, créez la variable `ynh_smtp_relay` et mettez vos propres valeu ...@@ -32,8 +28,6 @@ Pour faire cela, créez la variable `ynh_smtp_relay` et mettez vos propres valeu
      ### Concernant les mises à jour ### Concernant les mises à jour
      ------------
      ```yml ```yml
      # Autoupdate Yunohost and its apps # Autoupdate Yunohost and its apps
      ynh_autoupdate: ynh_autoupdate:
      ...@@ -58,14 +52,10 @@ Pour en savoir plus sur le fonctionnement des mises à jour dans Yunohost vous p ...@@ -58,14 +52,10 @@ Pour en savoir plus sur le fonctionnement des mises à jour dans Yunohost vous p
      ## Dépendances ## Dépendances
      ------------
      Aucune. Aucune.
      ## Exemple de Playbook ## Exemple de Playbook
      ------------
      ```yml ```yml
      --- ---
      - name: Configure Yunohost on Debian Server - name: Configure Yunohost on Debian Server
      ...@@ -79,8 +69,6 @@ Aucune. ...@@ -79,8 +69,6 @@ Aucune.
      ## License ## License
      ------------
      [![ansible-yunohost Copyright 2021 Lydra](https://www.gnu.org/graphics/gplv3-with-text-136x68.png)](https://choosealicense.com/licenses/gpl-3.0/) [![ansible-yunohost Copyright 2021 Lydra](https://www.gnu.org/graphics/gplv3-with-text-136x68.png)](https://choosealicense.com/licenses/gpl-3.0/)
      **ansible-yunohost** est maintenu par [Lydra](https://lydra.fr/) et publié sous la licence GPL3. **ansible-yunohost** est maintenu par [Lydra](https://lydra.fr/) et publié sous la licence GPL3.
      roles/ynh_config/README.md
      + 0
      − 14
      View file @ c170aff7
      ...@@ -6,20 +6,14 @@ Deploy [Yunohost](https://yunohost.org/#/) with Ansible! ...@@ -6,20 +6,14 @@ Deploy [Yunohost](https://yunohost.org/#/) with Ansible!
      ## Requirements ## Requirements
      ------------
      None. None.
      ## Role Variables ## Role Variables
      ------------
      Default variables are available in `default/main.yml` however it is necessary to override them according to your needs for Yunohost domains, users and apps. Default variables are available in `default/main.yml` however it is necessary to override them according to your needs for Yunohost domains, users and apps.
      ### SMTP relay configuration ### SMTP relay configuration
      ------------
      ```yml ```yml
      # SMTP custom settings # SMTP custom settings
      ynh_smtp_relay: ynh_smtp_relay:
      ...@@ -34,8 +28,6 @@ In order to do so, create the `ynh_smtp_relay` variable and provide your own val ...@@ -34,8 +28,6 @@ In order to do so, create the `ynh_smtp_relay` variable and provide your own val
      ### About the updates ### About the updates
      ------------
      ```yml ```yml
      # Autoupdate Yunohost and its apps # Autoupdate Yunohost and its apps
      ynh_autoupdate: ynh_autoupdate:
      ...@@ -60,14 +52,10 @@ To learn more about how updates work in Yunohost you can go [here](https://yunoh ...@@ -60,14 +52,10 @@ To learn more about how updates work in Yunohost you can go [here](https://yunoh
      ## Dependencies ## Dependencies
      ------------
      None. None.
      ## Example Playbook ## Example Playbook
      ------------
      ```yml ```yml
      --- ---
      - name: Configure Yunohost on Debian Server - name: Configure Yunohost on Debian Server
      ...@@ -81,8 +69,6 @@ None. ...@@ -81,8 +69,6 @@ None.
      ## License ## License
      ------------
      [![ansible-yunohost Copyright 2021 Lydra](https://www.gnu.org/graphics/gplv3-with-text-136x68.png)](https://choosealicense.com/licenses/gpl-3.0/) [![ansible-yunohost Copyright 2021 Lydra](https://www.gnu.org/graphics/gplv3-with-text-136x68.png)](https://choosealicense.com/licenses/gpl-3.0/)
      **ansible-yunohost** is maintained by [Lydra](https://lydra.fr/) and released under the GPL3 license. **ansible-yunohost** is maintained by [Lydra](https://lydra.fr/) and released under the GPL3 license.
      0% or .
      You are about to add 0 people to the discussion. Proceed with caution.
      Finish editing this message first!
      Please register or to comment

      Froggit est fièrement fabriqué avec amour par Lydra avec des Logiciels Libres et hébergé en France chez Scaleway | Status du service