From bb450ba302f2d458c20a3f70a1d9960040feb36c Mon Sep 17 00:00:00 2001 From: ericgaspar Date: Sat, 5 Sep 2020 17:32:15 +0200 Subject: [PATCH] cleaning up --- README.md | 25 ++++++++++++------------- README_fr.md | 39 +++++++++++++++++++-------------------- config_panel.toml | 28 ++++++++++++++-------------- manifest.json | 32 ++++++++++++++++---------------- scripts/_variables | 8 ++++---- 5 files changed, 65 insertions(+), 67 deletions(-) diff --git a/README.md b/README.md index 42616c4..550ec21 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -# Etherpad with mypads plugin for YunoHost +# Etherpad with MyPads plugin for YunoHost [![Integration level](https://dash.yunohost.org/integration/etherpad_mypads.svg)](https://dash.yunohost.org/appci/app/etherpad_mypads) ![](https://ci-apps.yunohost.org/ci/badges/etherpad_mypads.status.svg) [![](https://ci-apps.yunohost.org/ci/badges/etherpad_mypads.maintain.svg)](https://github.com/YunoHost/Apps/#what-to-do-if-i-cant-maintain-my-app-anymore-) [![Install Etherpad with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=etherpad_mypads) *[Lire ce readme en français.](./README_fr.md)* -> *This package allow you to install etherpad quickly and simply on a YunoHost server. +> *This package allow you to install Etherpad quickly and simply on a YunoHost server. If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* ## Overview @@ -16,7 +16,7 @@ This package will install the same plugins than [Framapad](https://framapad.org/ ## Screenshots -![](http://etherpad.org/img/screenshot.png) +![](https://github.com/ether/etherpad-lite/blob/develop/doc/images/etherpad_demo.gif) ## Demo @@ -24,25 +24,25 @@ This package will install the same plugins than [Framapad](https://framapad.org/ ## Configuration -You can access to 2 different admin panels, for etherpad by accessing `domain.tld/admin` and for mypads by `domain.tld/mypads/?/admin`. -Or, you can find a config file for etherpad at this path `/var/www/etherpad_mypads/settings.json`. +You can access two different admin panels, for Etherpad by accessing `domain.tld/admin` and for MyPads by `domain.tld/mypads/?/admin`. +You can also find a config file for Etherpad at this path `/var/www/etherpad_mypads/settings.json`. ## Documentation - * Official documentation: http://etherpad.org/doc/v1.7.0 - * YunoHost documentation: There no other documentations, feel free to contribute. + * Official documentation: http://etherpad.org/doc/v1.8.4 + * YunoHost documentation: https://yunohost.org/#/app_etherpad_mypads ## YunoHost specific features #### Multi-users support -Supported, with LDAP. + * Are LDAP and HTTP auth supported? **Yes** + * Can the app be used by multiple users? **Yes** #### Supported architectures -* x86-64b - [![](https://ci-apps.yunohost.org/ci/logs/etherpad_mypads%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/etherpad_mypads/) +* x86-64 - [![](https://ci-apps.yunohost.org/ci/logs/etherpad_mypads%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/etherpad_mypads/) * ARMv8-A - [![](https://ci-apps-arm.yunohost.org/ci/logs/etherpad_mypads%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/etherpad_mypads/) -* Buster x86-64b - [![](https://ci-buster.nohost.me/ci/logs/etherpad_mypads%20%28Apps%29.svg)](https://ci-buster.nohost.me/ci/apps/etherpad_mypads/) ## Limitations @@ -70,14 +70,13 @@ Supported, with LDAP. * Report a bug: https://github.com/YunoHost-Apps/etherpad_mypads_ynh/issues * Etherpad website: http://etherpad.org/ - * Mypads plugin website: https://git.framasoft.org/framasoft/ep_mypads + * MyPads plugin website: https://git.framasoft.org/framasoft/ep_mypads * Upstream app repository: https://github.com/ether/etherpad-lite * YunoHost website: https://yunohost.org/ --- -Developers infos ----------------- +## Developers infos Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/tree/testing). diff --git a/README_fr.md b/README_fr.md index b81c9df..50b6324 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,22 +1,22 @@ -# Etherpad avec plugin mypads pour YunoHost +# Etherpad avec plugin MyPads pour YunoHost [![Niveau d'intégration](https://dash.yunohost.org/integration/etherpad_mypads.svg)](https://dash.yunohost.org/appci/app/etherpad_mypads) ![](https://ci-apps.yunohost.org/ci/badges/etherpad_mypads.status.svg) [![](https://ci-apps.yunohost.org/ci/badges/etherpad_mypads.maintain.svg)](https://github.com/YunoHost/Apps/#what-to-do-if-i-cant-maintain-my-app-anymore-) [![Installer Etherpad avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=etherpad_mypads) *[Read this readme in english.](./README.md)* -> *Ce package vous permet d'installer etherpad rapidement et simplement sur un serveur YunoHost. +> *Ce package vous permet d'installer Etherpad rapidement et simplement sur un serveur YunoHost. Si vous n'avez pas YunoHost, merci de regarder [ici](https://yunohost.org/#/install_fr) pour savoir comment l'installer et en profiter.* ## Résumé Etherpad est un éditeur en ligne Open Source hautement personnalisable qui permet l'édition collaborative en temps réel. Ce paquet installera les mêmes plugins que [Framapad](https://framapad.org/). -**Version embarquée:** 1.8.4 +**Version embarquée :** 1.8.4 ## Captures d'écran -![](http://etherpad.org/img/screenshot.png) +![](https://github.com/ether/etherpad-lite/blob/develop/doc/images/etherpad_demo.gif) ## Démo @@ -24,31 +24,31 @@ Ce paquet installera les mêmes plugins que [Framapad](https://framapad.org/). ## Configuration -Vous pouvez accéder à 2 panneaux d'administration différents, pour etherpad en accédant à `domain.tld/admin` et pour mypads par `domain.tld/mypads/?/admin`. -Ou, vous pouvez trouver un fichier de configuration pour etherpad à `/var/www/etherpad_mypads/settings.json`. +Vous pouvez accéder à deux panneaux d'administration différents, pour Etherpad en accédant à `domain.tld/admin` et pour MyPads par `domain.tld/mypads/?/admin`. +Vous pouvez également trouver le fichier de configuration pour Etherpad à `/var/www/etherpad_mypads/settings.json`. ## Documentation - * Documentation officielle: http://etherpad.org/doc/v1.7.0 - * Documentation YunoHost: Il n'y a pas d'autre documentation, n'hésitez pas à contribuer. + * Documentation officielle : http://etherpad.org/doc/v1.8.4 + * Documentation YunoHost : https://yunohost.org/#/app_etherpad_mypads_fr ## Fonctionnalités spécifiques à YunoHost #### Support multi-utilisateurs -Supportée, avec LDAP. + * L'authentification LDAP et HTTP est-elle prise en charge ? **Oui** + * L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui** -#### Architectures supportées. +#### Architectures supportées -* x86-64b - [![](https://ci-apps.yunohost.org/ci/logs/etherpad_mypads%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/etherpad_mypads/) +* x86-64 - [![](https://ci-apps.yunohost.org/ci/logs/etherpad_mypads%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/etherpad_mypads/) * ARMv8-A - [![](https://ci-apps-arm.yunohost.org/ci/logs/etherpad_mypads%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/etherpad_mypads/) -* Buster x86-64b - [![](https://ci-buster.nohost.me/ci/logs/etherpad_mypads%20%28Apps%29.svg)](https://ci-buster.nohost.me/ci/apps/etherpad_mypads/) ## Limitations ## Informations additionnelles -* Ce paquet installera les plugins suivants: +* Ce paquet installera les plugins suivants : * [ep_align](https://www.npmjs.com/package/ep_align) - *Ajoute Gauche/Centre/Droite/Justifier à des lignes de texte dans un pad* * [ep_author_hover](https://www.npmjs.com/package/ep_author_hover) - *Ajoute des noms d'auteurs* @@ -68,16 +68,15 @@ Supportée, avec LDAP. ## Liens - * Reporter un bug: https://github.com/YunoHost-Apps/etherpad_mypads_ynh/issues - * Site de etherpad: http://etherpad.org/ - * Site du plugin mypads: https://git.framasoft.org/framasoft/ep_mypads - * Dépôt git de l'app: https://github.com/ether/etherpad-lite - * Site de YunoHost: https://yunohost.org/ + * Reporter un bug : https://github.com/YunoHost-Apps/etherpad_mypads_ynh/issues + * Site d'Etherpad : http://etherpad.org/ + * Site du plugin MyPads : https://git.framasoft.org/framasoft/ep_mypads + * Dépôt GitHub de l'application : https://github.com/ether/etherpad-lite + * Site de YunoHost : https://yunohost.org/ --- -Informations à l'intention des développeurs ----------------- +## Informations à l'intention des développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/tree/testing). diff --git a/config_panel.toml b/config_panel.toml index 3581e21..7045e5f 100644 --- a/config_panel.toml +++ b/config_panel.toml @@ -9,7 +9,7 @@ name = "Etherpad configuration" name = "Export" [main.export.export] - ask = "Use abiword (~260Mo) or libreoffice (~400Mo) (more stable) to expand export possibilities (pdf, doc) ?" + ask = "Use AbiWord (~260 Mo) or LibreOffice (~400 Mo) (more stable) to expand export possibilities (PDF, doc)?" choices = ["none", "abiword", "libreoffice"] default = "none" @@ -18,32 +18,32 @@ name = "Etherpad configuration" name = "Default pad configuration" [main.pad_configuration.pad_config_nocolors] - ask = "Hide authorship colors ?" + ask = "Hide authorship colors?" type = "boolean" default = false [main.pad_configuration.pad_config_showlinenumbers] - ask = "Show line numbers ?" + ask = "Show line numbers?" type = "boolean" default = true [main.pad_configuration.pad_config_chatandusers] - ask = "Show chat and users ?" + ask = "Show chat and users?" type = "boolean" default = false [main.pad_configuration.pad_config_alwaysshowchat] - ask = "Always show chat ?" + ask = "Always show chat?" type = "boolean" default = false [main.pad_configuration.pad_config_show_markdown] - ask = "Show markdown syntax ?" + ask = "Show markdown syntax?" type = "boolean" default = false [main.pad_configuration.pad_config_pageview] - ask = "Page view ?" + ask = "Page view?" type = "boolean" default = false @@ -63,12 +63,12 @@ name = "Etherpad configuration" name = "Mypads configuration" [main.mypads_configuration.mypads] - ask = "Enable Mypads plugin ?" + ask = "Enable MyPads plugin?" type = "boolean" default = true [main.mypads_configuration.useldap] - ask = "Use ldap with Mypads ?" + ask = "Use LDAP with MyPads?" type = "boolean" default = true @@ -80,32 +80,32 @@ name = "Etherpad configuration" ask = "Is it a public website?" type = "boolean" default = true - help = "If your etherpad instance is public, everyone will be able to create a pad or see an existing one." + help = "If your Etherpad instance is public, everyone will be able to create a pad or see an existing one." [main.overwrite_files] name = "Overwriting config files during an upgrade" [main.overwrite_files.overwrite_settings] - ask = "Overwrite the config file settings.json ?" + ask = "Overwrite the config file settings.json?" type = "boolean" default = true help = "If the file is overwritten, a backup will be created." [main.overwrite_files.overwrite_credentials] - ask = "Overwrite the config file credentials.json ?" + ask = "Overwrite the config file credentials.json?" type = "boolean" default = true help = "If the file is overwritten, a backup will be created." [main.overwrite_files.overwrite_nginx] - ask = "Overwrite the nginx config file ?" + ask = "Overwrite the NGINX config file?" type = "boolean" default = true help = "If the file is overwritten, a backup will be created." [main.overwrite_files.overwrite_systemd] - ask = "Overwrite the systemd config file ?" + ask = "Overwrite the systemd config file?" type = "boolean" default = true help = "If the file is overwritten, a backup will be created." diff --git a/manifest.json b/manifest.json index 35ae577..69f473e 100644 --- a/manifest.json +++ b/manifest.json @@ -3,8 +3,8 @@ "id": "etherpad_mypads", "packaging_format": 1, "description": { - "en": "Framapad clone, a online editor providing collaborative editing in real-time.", - "fr": "Clone de Framapad, un éditeur en ligne fournissant l'édition collaborative en temps réel." + "en": "Online editor providing collaborative editing in real-time. Framapad clone.", + "fr": "Éditeur en ligne fournissant l'édition collaborative en temps réel. Clone de Framapad." }, "version": "1.8.4~ynh1", "url": "https://framapad.org", @@ -31,8 +31,8 @@ "name": "domain", "type": "domain", "ask": { - "en": "Choose a domain for Etherpad Mypads.", - "fr": "Choisissez un domaine pour Etherpad Mypads." + "en": "Choose a domain for Etherpad MyPads.", + "fr": "Choisissez un domaine pour Etherpad MyPads." }, "example": "sub.domain.org" }, @@ -50,8 +50,8 @@ "name": "admin", "type": "user", "ask": { - "en": "Choose the Etherpad Mypads administrator (must be an existing YunoHost user)", - "fr": "Administrateur du site (doit être un utilisateur YunoHost existant)" + "en": "Choose the Etherpad MyPads administrator (must be an existing YunoHost user)", + "fr": "Choisissez l'administrateur Etherpad MyPads (doit être un utilisateur YunoHost existant)" }, "example": "john" }, @@ -82,8 +82,8 @@ "fr": "Est-ce un site public ?" }, "help": { - "en": "If your etherpad instance is public, everyone will be able to create a pad or see an existing one.", - "fr": "Si votre instance etherpad est publique, tout le monde pourra créer un pad ou voir un existant." + "en": "If your Etherpad instance is public, everyone will be able to create a pad or see an existing one.", + "fr": "Si votre instance Etherpad est publique, tout le monde pourra créer un pad ou voir un pad existant." }, "default": true }, @@ -91,8 +91,8 @@ "name": "export", "type": "string", "ask": { - "en": "Use abiword (~260Mo) or libreoffice (~400Mo) (more stable) to expand export possibilities (pdf, doc) ?", - "fr": "Utiliser abiword (~260Mo) ou libre office (~400Mo) (plus stable) pour étendre les possibilités d'export (pdf, doc) ?" + "en": "Use AbiWord (~260 Mo) or LibreOffice (~400 Mo) (more stable) to expand export possibilities (PDF, doc)?", + "fr": "Utiliser AbiWord (~260 Mo) ou LibreOffice (~400 Mo) (plus stable) pour étendre les possibilités d'export (PDF, doc) ?" }, "choices" : ["none", "abiword", "libreoffice"], "default" : "none" @@ -101,8 +101,8 @@ "name": "mypads", "type": "boolean", "ask": { - "en": "Do you want to install mypads plugin ?", - "fr": "Voulez-vous installer le plugin mypads ?" + "en": "Do you want to install MyPads plugin?", + "fr": "Voulez-vous installer le plugin MyPads ?" }, "help": { "en": "mypads plugin" @@ -113,12 +113,12 @@ "name": "useldap", "type": "boolean", "ask": { - "en": "Do you want to use ldap with mypads ?", - "fr": "Voulez-vous utiliser ldap avec mypads ?" + "en": "Do you want to use LDAP with MyPads?", + "fr": "Voulez-vous utiliser LDAP avec MyPads ?" }, "help": { - "en": "Using ldap won't let you add new user aside from YunoHost users.", - "fr": "Utiliser ldap ne vous permettra pas d'ajouter un nouvel utilisateur en dehors des utilisateurs de YunoHost." + "en": "Using LDAP won't let you add new user aside from YunoHost users.", + "fr": "Utiliser LDAP ne vous permettra pas d'ajouter un nouvel utilisateur en dehors des utilisateurs de YunoHost." }, "default": true } diff --git a/scripts/_variables b/scripts/_variables index 69d0bed..d9bdda0 100644 --- a/scripts/_variables +++ b/scripts/_variables @@ -1,16 +1,16 @@ #!/bin/bash -# Dependencies for abiword +# Dependencies for AbiWord abiword_app_depencencies="abiword" -# Dependencies for libre office +# Dependencies for LibreOffice libreoffice_app_dependencies="unoconv libreoffice-writer" # NodeJS version nodejs_version=12 -# Mypads version -# This variable is mostly used to force an upgrade of the package in case of new versions of mypads. +# MyPads version +# This variable is mostly used to force an upgrade of the package in case of new versions of MyPads. mypads_version=1.7.17 # Plugin versions