Je signale aussi que la première info qui est donnée sur une possible documentation est celle qui apparait sur la page doc des apps ici :
https://yunohost.org/#/apps
Chaque “app” présente 2 liens boutons :
- Code : qui renvoie vers la page d’accueil du github, plutôt familière pour les admin/dev/sys , mais pas pour tous les admins de Yunohost.
- Doc : qui inviterait à quelque chose de plus simple et plus convivial.
D’ailleurs, pourquoi le lien Doc pointe-t-il vers la page forcément en anglais “_en.md” par défaut au lieu de app_APPLICATION qui est un lien plus commun et valable selon la langue du navigateur ?
Pourrait-on le corriger ?
Je soumettrai bien le lien :
<a href="#/app_{app_id}" target="_BLANK" type="button" class="btn btn-default col-sm-4"><span class="glyphicon glyphicon-book" aria-hidden="true"></span> Doc</a>
au lieu de :
<a href="#/app_{app_id}_en" target="_BLANK" type="button" class="btn btn-default col-sm-4"><span class="glyphicon glyphicon-book" aria-hidden="true"></span> Doc</a>
Personnellement, je pense qu’il faut les 2.
Sans doute même que la forme est à retravailler, mais il faudrait choisir un lieu et un fonctionnement pour qu’il n’y ait pas de doublon d’infos, trop lourdes à maintenir.
Les packageurs doivent adresser des infos pour les admins, tandis que la page de doc s’adresse à ceux qui veulent en savoir plus sur l’application et doit rester permanente :
Page de doc (dans yunohost)
- Logo + Nom
- Niveau d’intégration + lien installation
- Présentation de l’application
- Captures d’écran
- lien vers site officiel
- lien vers documentation
- lien vers dépôt de l’app
- lien vers remontée de bug
Les infos comme les limitations, la configuration, les mises à jour relèvent du packageur et qui sont amenés à évoluer, devraient se retrouver dans les README du dépot.
Page README.md
- Nom Appli
- Site officiel
- Lien vers page de doc
- version fournie
- Configurations
- Administration
Dans le dépot exemple : https://github.com/YunoHost/example_ynh
les parties screenshot, demo me sembleraient superflues.
et seule la version anglaise du readme (pour admin) serait utile, alors que les pages de doc pourraient être traduites en plusieurs langues facilement par des traducteurs en masse.
Dans cette page : https://yunohost.org/#/doc_writing_guide
Je pense que les infos des points 5, 6 et 7 relèvent donc du packageur.