YunoHost/doc
1
0
Fork 0
mirror of https://github.com/YunoHost/doc.git synced 2024-09-03 20:06:26 +02:00
Code Issues Projects Releases Packages Wiki Activity

[enh] packaging: manifest: add 'packaging_format' key.

Browse source
This commit is contained in:
Moul 2016-04-28 18:23:31 +02:00
parent 6d92aea439
commit 65ccefad23
2 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
packaging_apps_manifest.md
View file

@ -6,6 +6,7 @@ The `manifest.json` file defines the app's constants, a bunch of values that Yun
{ {
"name": "Roundcube", "name": "Roundcube",
"id": "roundcube", "id": "roundcube",
"packaging_format": 1,
"description": { "description": {
"en": "Open Source Webmail software", "en": "Open Source Webmail software",
"fr": "Webmail Open Source" "fr": "Webmail Open Source"
@ -52,6 +53,8 @@ The `manifest.json` file defines the app's constants, a bunch of values that Yun
* **id**: ID of the app. You have to ensure that this ID is unique before submit an app integration request. * **id**: ID of the app. You have to ensure that this ID is unique before submit an app integration request.
- **packaging_format**: package version. Actual version is **1**. This key has been set up to make independant packaging evolution versions from YunoHost versions evolution.
* **description**: complete app description. You can make it as detailed as you feel it should be. Only `en` is required right now, but you can translate the description by prepending the locale prefix. * **description**: complete app description. You can make it as detailed as you feel it should be. Only `en` is required right now, but you can translate the description by prepending the locale prefix.
* **url**: software website. * **url**: software website.
@ -71,4 +74,4 @@ The `manifest.json` file defines the app's constants, a bunch of values that Yun
* **optional** : (optional) field which indicate if this argument is optional. It can have `true` and `false` value. * **optional** : (optional) field which indicate if this argument is optional. It can have `true` and `false` value.
* **ask**: question (at least in `en`) that you can translate. * **ask**: question (at least in `en`) that you can translate.
* **example**: (optional) example value to help administrator to fill the input. * **example**: (optional) example value to help administrator to fill the input.
* **default**: (optional) default value. * **default**: (optional) default value.

5
packaging_apps_manifest_fr.md
View file

@ -6,6 +6,7 @@ Le fichier `manifest.json` définit les constantes de l’application, un ensemb
{ {
"name": "Roundcube", "name": "Roundcube",
"id": "roundcube", "id": "roundcube",
"packaging_format": 1,
"description": { "description": {
"en": "Open Source Webmail software", "en": "Open Source Webmail software",
"fr": "Webmail Open Source" "fr": "Webmail Open Source"
@ -52,6 +53,8 @@ Le fichier `manifest.json` définit les constantes de l’application, un ensemb
* **id** : identifiant de l’application. Vous devez vous assurer de son unicité. * **id** : identifiant de l’application. Vous devez vous assurer de son unicité.
- **packaging_format** : version de packaging du paquet. La version **1** est la version actuelle. Cette clé a été mise en place afin de faire évoluer les versions de packaging de manière décorrélée des versions de YunoHost.
* **description** : description complète de l’application. Vous pouvez la détailler comme bon vous semble. Uniquement le champs `en` (english) est requis, vous pouvez également ajouter la traduction en français :) * **description** : description complète de l’application. Vous pouvez la détailler comme bon vous semble. Uniquement le champs `en` (english) est requis, vous pouvez également ajouter la traduction en français :)
* **url**: site de l’application. * **url**: site de l’application.
@ -71,4 +74,4 @@ Le fichier `manifest.json` définit les constantes de l’application, un ensemb
* **optional** : (optionnel) champs qui indique si ce paramètre est optionnel. Il peux avoir les valeurs `true` ou `false`. * **optional** : (optionnel) champs qui indique si ce paramètre est optionnel. Il peux avoir les valeurs `true` ou `false`.
* **ask** : question posée (au minimum en anglais – `en`) que vous pouvez traduire dans plusieurs langues. * **ask** : question posée (au minimum en anglais – `en`) que vous pouvez traduire dans plusieurs langues.
* **example** : (optionnel) valeur d’exemple pour aider l’administrateur à remplir le formulaire d’installation. * **example** : (optionnel) valeur d’exemple pour aider l’administrateur à remplir le formulaire d’installation.
* **default** : (optionnel) valeur par défaut. * **default** : (optionnel) valeur par défaut.