[enh] packaging_apps_helpers: hide deprecated helpers and update information about new helpers.

- hide deprecated helpers from YunoHost 2.2.
- update information about new helpers from YunoHost 2.4:
 - Add example
 - Link the example app
 - Update link to the helpers repository
This commit is contained in:
Moul 2016-05-20 12:08:06 +02:00
parent 55a864367b
commit 7897c95750
2 changed files with 20 additions and 15 deletions

View file

@ -1,16 +1,20 @@
<a class="btn btn-lg btn-default" href="packaging_apps_en">Application packaging</a>
### Helpers
It's recommended to use helpers.
## Shell helpers
#### Shell
From YunoHost 2.4, [shell helpers](https://dev.yunohost.org/projects/yunohost/repository/yunohost/revisions/unstable/show/data/helpers.d) are available.
Since YunoHost 2.4 release, **new shell helpers** are available to ease packaging, in particular for common tasks like password generation, MySQL database creation…
Examples are available in the [example application](https://github.com/YunoHost/example_ynh/blob/master/scripts/install). We advise to use them.
You can find them on this [repository](https://github.com/YunoHost/yunohost/blob/unstable/data/helpers.d).
To use them, you need to add following lines in the shell scripts:
```bash
# Source app helpers
. /usr/share/yunohost/helpers
```
<!--
<br />
#### Moulinette
@ -78,4 +82,5 @@ sudo yunohost app ssowatconf
```
<blockquote>
This helper reloads the SSO configuration. You have to call it at the end of the script when you are packaging a web app.
</blockquote>
</blockquote>
-->

View file

@ -1,16 +1,15 @@
<a class="btn btn-lg btn-default" href="packaging_apps_fr">Packaging dapplication</a>
## Commandes pratiques
Il est conseillé dutiliser les commandes pratiques.
#### Shell
À partir de YunoHost 2.4, des [helpers en shell](https://dev.yunohost.org/projects/yunohost/repository/yunohost/revisions/unstable/show/data/helpers.d) sont disponible.
## Commandes pratiques en Shell
Pour pouvoir les utiliser il faut ajouter les lignes suivantes :
```bash
# Source app helpers
. /usr/share/yunohost/helpers
```
À partir de YunoHost 2.4, de **nouvelles commandes pratiques *(helpers)* en shell** sont disponible pour faciliter le *packaging*, particulièrement pour des tâches répétitives comme la génération de mot de passe, la création de base de donnés MySQL…
Des exemples sont disponibles dans l[application dexemple](https://github.com/YunoHost/example_ynh/blob/master/scripts/install). Il est conseillé dutiliser les commandes pratiques.
Vous pourrez les retrouver dans ce [dépôt](https://github.com/YunoHost/yunohost/blob/unstable/data/helpers.d).
<!--
<br />
#### Moulinette
@ -87,4 +86,5 @@ sudo yunohost app ssowatconf
```
<blockquote>
Cette commande régénère la configuration du SSO. Vous devez lappeler à la fin des scripts lorsque vous packagez une application Web.
</blockquote>
</blockquote>
-->