From 2b700e48a50b7ce9084fb128ba9adeb37997ea88 Mon Sep 17 00:00:00 2001 From: Jaxom99 Date: Fri, 8 Mar 2019 15:51:42 +0100 Subject: [PATCH 1/4] ajout liste non-free --- packaging_apps.md | 4 +++- packaging_apps_fr.md | 4 +++- packaging_apps_guidelines.md | 4 +++- packaging_apps_guidelines_fr.md | 6 ++++-- 4 files changed, 13 insertions(+), 5 deletions(-) diff --git a/packaging_apps.md b/packaging_apps.md index c667d4a5..47733df3 100644 --- a/packaging_apps.md +++ b/packaging_apps.md @@ -118,9 +118,11 @@ This Python script checks: ### Publish and ask for testing your application * Publishing a [post on the Forum](https://forum.yunohost.org/) with the [`App integration` category](https://forum.yunohost.org/c/app-integration), to ask for testing and feedback on your application. -* Ask your application to be added to the [app repository](https://github.com/YunoHost/apps) to be displayed in the [non-official apps list](apps_en). Specify its progress state: `notworking`, `inprogress`, or `working`. +* If your application is released under free softare licence, ask your application to be added to the [app repository](https://github.com/YunoHost/apps) to be displayed in the [non-official apps list](apps_en). Otherwise you may find a non-official list to add you app to, easing the installation on Yunohost (non-existent yet). Specify its progress state: `notworking`, `inprogress`, or `working`. - Subscribe to the [Apps mailing list](https://list.yunohost.org/cgi-bin/mailman/listinfo/apps) to be informed about packaging evolution. ### Officalization of an application +**!! This section is obsolete as of 08/03/19** - The project's organization regarging this point is to be changed. + To become an official application, it must be tested well enough, be stable and should work on Debian Stretch 64 bits, 32 bits and ARM architectures. If you think those conditions are met, ask for [official integration](https://github.com/YunoHost/apps) of your application. diff --git a/packaging_apps_fr.md b/packaging_apps_fr.md index 30a4be72..b88e8f43 100644 --- a/packaging_apps_fr.md +++ b/packaging_apps_fr.md @@ -100,9 +100,11 @@ Il s’agit d’un script Python qui vérifie : ### Publiez et demandez des tests de votre application * Demandez des tests et des retours sur votre application en publiant un [post sur le Forum](https://forum.yunohost.org/) dans la [catégorie `App integration`](https://forum.yunohost.org/c/app-integration). -* Faire une demande d’ajout de votre application dans le [dépôt des applications](https://github.com/YunoHost/apps) afin qu’elle soit affichée dans [la liste des apps non officielles](apps_fr). Préciser également son état d’avancement : `notworking`, `inprogress` ou `working`. +* Si votre paquet et l'application qu'il contient sont sous licence libre, faites une demande d’ajout de votre application dans le [dépôt des applications](https://github.com/YunoHost/apps) afin qu’elle soit affichée dans [la liste des apps non officielles](apps_fr). Autrement, cherchez une liste non-officielle à laquelle vous rajouter (non-existante à ce jour), pour permettre son installation intégrée dans Yunohost. Préciser également son état d’avancement : `notworking`, `inprogress` ou `working`. - Inscrivez-vous à la [mailing list Apps](https://list.yunohost.org/cgi-bin/mailman/listinfo/apps) pour être tenu au courant des évolutions du packaging. ### Officialisation d’une application +**!! Section obsolète au 08/03/19** - Le fonctionnement du projet est en cours d'évolution sur ce point. + Pour qu’une application devienne officielle, elle doit être suffisamment testée, stable et fonctionner sous Debian Stretch 64 bits, 32 bits et ARM. Si ces conditions vous paraissent réunies, demandez l’[intégration officielle](https://github.com/YunoHost/apps) de votre application. diff --git a/packaging_apps_guidelines.md b/packaging_apps_guidelines.md index 19ee3aa0..7b962d87 100644 --- a/packaging_apps_guidelines.md +++ b/packaging_apps_guidelines.md @@ -112,7 +112,7 @@ These deposits have several functions: * indicate the state of operation of the packet; * indicate information about the support of a package. -For the `official.json` and` community.json` lists, registration is on [the git apps repository](https://github.com/YunoHost/apps). +For the `official.json` and` community.json` lists maintained by the project team, registration is on [the git apps repository](https://github.com/YunoHost/apps). Other non-official lists may exists (including those for non-free apps for example), see more about that in the [community forum](https//forum.yunohost.org). #### YEP 1.3 ##### Indicate the license associated with the package | draft | AUTO | WORKING | @@ -120,6 +120,8 @@ The license of the packet must be specified in a `LICENSE` file at the root of t The application lists official.json and community.json only accept packages with a free license, as well as the license for the contained application. Some free applications require non-free dependencies (example: mp3, drivers, etc.). In this case, you should add `&dep-non-free` to the acronym and if possible give details in the README.md of the package, in this case the integration will be accepted on a case-by-case basis. +**NB:** Packets not included in offical lists may still be installed: either manually with the URL to the packet, or in a more practical way using other lists (which remain to be created by the community). + In the future, YunoHost will probably display details about the license of the application. To achieve this, the acronym must be the one from this [list of licenses listed in the SPDX](https://spdx.org/licenses/) (if there are 2 acronyms, the one containing the version number). For consistency, the case must be respected. If the license is not present in the list, in this case it is necessary to indicate `free` or `non-free` depending on whether it is free or not and give the user the opportunity to inquire in the README .md (link, explanations, ...). diff --git a/packaging_apps_guidelines_fr.md b/packaging_apps_guidelines_fr.md index 4874d410..8ace2924 100644 --- a/packaging_apps_guidelines_fr.md +++ b/packaging_apps_guidelines_fr.md @@ -13,7 +13,7 @@ Ce document a pour but de lister les différentes bonnes pratiques concernant la Chaque bonne pratique est numérotée avec un numéro suffixé par les lettres YEP (YunoHost Enhancement Proposals), ceci afin de pouvoir y faire référence facilement dans les outils d'analyse automatique de paquet ([package checker](https://github.com/YunoHost/package_check), [package linter](https://github.com/YunoHost/package_linter)), mais également lors des revues de code. Chaque YEP est associée à : -* un statut indiquant si la règle a été validé ou si elle fait encore l'objet de discussion (brouillon, validé, refusé, obsolète) ; +* un statut indiquant si la règle a été validée ou si elle fait encore l'objet de discussion (brouillon, validé, refusé, obsolète) ; * une indication sur le type de test à mener (manuel ou auto si un outil automatique peut vérifier) ; * une indication du niveau d'app à partir duquel la règle est nécessaire (NOTWORKING, INPROGRESS, WORKING, OFFICIAL), certaines règles sont optionnelles ; @@ -113,7 +113,7 @@ Ces dépôts ont plusieurs fonctions : * indiquer l'état de fonctionnement du paquet ; * indiquer des informations sur le support d'un paquet. -Pour les listes `official.json` et `community.json`, l'inscription se fait sur [le dépôt git "apps"](https://github.com/YunoHost/apps). +Pour les listes `official.json` et `community.json` maintenues par l'équipe du projet Yunohost, l'inscription se fait sur [le dépôt git "apps"](https://github.com/YunoHost/apps). D'autres listes non-officielles (notamment celles incluant des applications non-libres) peuvent exister, se réferer au [Forum](https://forum.yunohost.org) de la communauté. #### YEP 1.3 ##### Indiquer la licence associée au paquet | brouillon | AUTO | WORKING | @@ -121,6 +121,8 @@ La licence du paquet est à indiquer dans un fichier `LICENSE` à la racine du p Les listes d'applications official.json et community.json n'acceptent que les paquets dont la licence est libre, de même pour la licence de l'application contenue. Certaines applications libres nécessitent des dépendances non-libres (exemple: mp3, drivers, etc.). Dans ce cas, il faut ajouter `&dep-non-free` à l'acronyme et si possible donner des précisions dans le README.md du paquet, l'intégration sera dans ce cas acceptée au cas par cas. +**NB :** Les paquets non-inclus dans les listes maintenues par le projet peuvent tout de même être installés : soit manuellement via le lien du paquet, soit de manière plus intégrée via des listes non-officielles (qui restent encore à créer par la communauté). + Dans le futur, YunoHost affichera sans doute des détails sur la licence de l'application. Pour y parvenir, l'acronyme doit être celui issu de cette [liste de licences répertoriées du SPDX](https://spdx.org/licenses/) (si il y a 2 acronymes, il faut prendre celui contenant le numéro de version). Pour plus de cohérence, la casse doit être respectée. Si la licence n'est pas présente dans la liste, dans ce cas il faut indiquer `free` ou `non-free` selon qu'elle est libre ou non et donner l'occasion à l'utilisateur de se renseigner dans le README.md (lien, explications, ...). From f2933b00887f395e5d569bf2ba9207b65e996448 Mon Sep 17 00:00:00 2001 From: Alexandre Aubin Date: Fri, 8 Mar 2019 17:07:57 +0100 Subject: [PATCH 2/4] Rework wording / separate the note about nonfree app ? --- packaging_apps.md | 6 +++++- packaging_apps_fr.md | 6 +++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/packaging_apps.md b/packaging_apps.md index 47733df3..03481fb4 100644 --- a/packaging_apps.md +++ b/packaging_apps.md @@ -116,13 +116,17 @@ This Python script checks: * that scripts exit well before modifing the system during verification. ### Publish and ask for testing your application + * Publishing a [post on the Forum](https://forum.yunohost.org/) with the [`App integration` category](https://forum.yunohost.org/c/app-integration), to ask for testing and feedback on your application. -* If your application is released under free softare licence, ask your application to be added to the [app repository](https://github.com/YunoHost/apps) to be displayed in the [non-official apps list](apps_en). Otherwise you may find a non-official list to add you app to, easing the installation on Yunohost (non-existent yet). Specify its progress state: `notworking`, `inprogress`, or `working`. +* If your application is released under a free software license, you may ask the YunoHost app team to integrate your application to the [app repository](https://github.com/YunoHost/apps) (c.f. also the [app list](apps_en)). You can add your application even if it is not stable or working yet : the current state can be specified to `notworking`, `inprogress`, or `working`. + +* If your application is *not* free software, then in the future, a non-official list might be created to handle them but is non-existent yet. - Subscribe to the [Apps mailing list](https://list.yunohost.org/cgi-bin/mailman/listinfo/apps) to be informed about packaging evolution. ### Officalization of an application + **!! This section is obsolete as of 08/03/19** - The project's organization regarging this point is to be changed. To become an official application, it must be tested well enough, be stable and should work on Debian Stretch 64 bits, 32 bits and ARM architectures. If you think those conditions are met, ask for [official integration](https://github.com/YunoHost/apps) of your application. diff --git a/packaging_apps_fr.md b/packaging_apps_fr.md index b88e8f43..78f6b8b8 100644 --- a/packaging_apps_fr.md +++ b/packaging_apps_fr.md @@ -98,13 +98,17 @@ Il s’agit d’un script Python qui vérifie : * que les scripts quittent bien avant de modifier le système lors de vérifications. ### Publiez et demandez des tests de votre application + * Demandez des tests et des retours sur votre application en publiant un [post sur le Forum](https://forum.yunohost.org/) dans la [catégorie `App integration`](https://forum.yunohost.org/c/app-integration). -* Si votre paquet et l'application qu'il contient sont sous licence libre, faites une demande d’ajout de votre application dans le [dépôt des applications](https://github.com/YunoHost/apps) afin qu’elle soit affichée dans [la liste des apps non officielles](apps_fr). Autrement, cherchez une liste non-officielle à laquelle vous rajouter (non-existante à ce jour), pour permettre son installation intégrée dans Yunohost. Préciser également son état d’avancement : `notworking`, `inprogress` ou `working`. +* Si votre paquet et l'application qu'il contient sont sous licence libre, faites une demande d’ajout de votre application dans le [dépôt des applications](https://github.com/YunoHost/apps) (voir aussi [la liste des apps](apps_fr)). Vous pouvez ajouter une application même si celle-ci n'est pour le moment pas fonctionelle : l'état d'avancement peut être `notworking`, `inprogress` ou `working`. + +* Si votre application n'est *pas* sous licence libre, il se peut qu'une liste non-officielle soit créée pour gérer ces applications. Ce n'est pour l'instant pas le cas. - Inscrivez-vous à la [mailing list Apps](https://list.yunohost.org/cgi-bin/mailman/listinfo/apps) pour être tenu au courant des évolutions du packaging. ### Officialisation d’une application + **!! Section obsolète au 08/03/19** - Le fonctionnement du projet est en cours d'évolution sur ce point. Pour qu’une application devienne officielle, elle doit être suffisamment testée, stable et fonctionner sous Debian Stretch 64 bits, 32 bits et ARM. Si ces conditions vous paraissent réunies, demandez l’[intégration officielle](https://github.com/YunoHost/apps) de votre application. From 1cc0b5f6688a802e81ebdc70d17df844b2283bd8 Mon Sep 17 00:00:00 2001 From: Alexandre Aubin Date: Fri, 8 Mar 2019 17:08:20 +0100 Subject: [PATCH 3/4] This mailing list aint maintained anymore, probably want to remove it --- packaging_apps.md | 2 -- packaging_apps_fr.md | 2 -- 2 files changed, 4 deletions(-) diff --git a/packaging_apps.md b/packaging_apps.md index 03481fb4..7206849f 100644 --- a/packaging_apps.md +++ b/packaging_apps.md @@ -123,8 +123,6 @@ This Python script checks: * If your application is *not* free software, then in the future, a non-official list might be created to handle them but is non-existent yet. -- Subscribe to the [Apps mailing list](https://list.yunohost.org/cgi-bin/mailman/listinfo/apps) to be informed about packaging evolution. - ### Officalization of an application **!! This section is obsolete as of 08/03/19** - The project's organization regarging this point is to be changed. diff --git a/packaging_apps_fr.md b/packaging_apps_fr.md index 78f6b8b8..6105b88d 100644 --- a/packaging_apps_fr.md +++ b/packaging_apps_fr.md @@ -105,8 +105,6 @@ Il s’agit d’un script Python qui vérifie : * Si votre application n'est *pas* sous licence libre, il se peut qu'une liste non-officielle soit créée pour gérer ces applications. Ce n'est pour l'instant pas le cas. -- Inscrivez-vous à la [mailing list Apps](https://list.yunohost.org/cgi-bin/mailman/listinfo/apps) pour être tenu au courant des évolutions du packaging. - ### Officialisation d’une application **!! Section obsolète au 08/03/19** - Le fonctionnement du projet est en cours d'évolution sur ce point. From 5be8ec4a39932642f7e8638f7013d9335e7a8fa3 Mon Sep 17 00:00:00 2001 From: Alexandre Aubin Date: Fri, 8 Mar 2019 17:12:59 +0100 Subject: [PATCH 4/4] Moar wording? --- packaging_apps_guidelines.md | 2 +- packaging_apps_guidelines_fr.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packaging_apps_guidelines.md b/packaging_apps_guidelines.md index 7b962d87..7a8650f4 100644 --- a/packaging_apps_guidelines.md +++ b/packaging_apps_guidelines.md @@ -120,7 +120,7 @@ The license of the packet must be specified in a `LICENSE` file at the root of t The application lists official.json and community.json only accept packages with a free license, as well as the license for the contained application. Some free applications require non-free dependencies (example: mp3, drivers, etc.). In this case, you should add `&dep-non-free` to the acronym and if possible give details in the README.md of the package, in this case the integration will be accepted on a case-by-case basis. -**NB:** Packets not included in offical lists may still be installed: either manually with the URL to the packet, or in a more practical way using other lists (which remain to be created by the community). +**NB:** Apps not included in offical lists may still be installed: either manually with the URL to the app, or in a more practical way using non-official lists (which can be created and maintained by the community). In the future, YunoHost will probably display details about the license of the application. To achieve this, the acronym must be the one from this [list of licenses listed in the SPDX](https://spdx.org/licenses/) (if there are 2 acronyms, the one containing the version number). For consistency, the case must be respected. diff --git a/packaging_apps_guidelines_fr.md b/packaging_apps_guidelines_fr.md index 8ace2924..4a451e75 100644 --- a/packaging_apps_guidelines_fr.md +++ b/packaging_apps_guidelines_fr.md @@ -121,7 +121,7 @@ La licence du paquet est à indiquer dans un fichier `LICENSE` à la racine du p Les listes d'applications official.json et community.json n'acceptent que les paquets dont la licence est libre, de même pour la licence de l'application contenue. Certaines applications libres nécessitent des dépendances non-libres (exemple: mp3, drivers, etc.). Dans ce cas, il faut ajouter `&dep-non-free` à l'acronyme et si possible donner des précisions dans le README.md du paquet, l'intégration sera dans ce cas acceptée au cas par cas. -**NB :** Les paquets non-inclus dans les listes maintenues par le projet peuvent tout de même être installés : soit manuellement via le lien du paquet, soit de manière plus intégrée via des listes non-officielles (qui restent encore à créer par la communauté). +**NB :** Les applications non-présentes dans les listes maintenues par le projet peuvent tout de même être installées : soit manuellement via le lien de l'application, soit de manière plus intégrée via des listes non-officielles (qui peuvent être créées et maintenues par la communauté). Dans le futur, YunoHost affichera sans doute des détails sur la licence de l'application. Pour y parvenir, l'acronyme doit être celui issu de cette [liste de licences répertoriées du SPDX](https://spdx.org/licenses/) (si il y a 2 acronymes, il faut prendre celui contenant le numéro de version). Pour plus de cohérence, la casse doit être respectée.