Bonjour Plumus (à moins que tu préfères que je t'appelle Super, pas de chichi hein)
pour la doc, il est vrai que ça n'a jamais été parfait. Elle a toujours été en retard sur le logiciel.
Je l'ai réécrite à plusieurs reprises, mais beaucoup de nouvelles fonctions qu'on ajoute dans PlayOnLinux/PlayOnMac ne sont pas ajoutées à la doc.
L'une des raisons est que peu de personnes en dehors de l'équipe font des scripts actuellement. L'autre raison est l'oubli/le manque de temps.
Je comprends bien ce genre de problème, maintenir une doc à jour c'est galère. Dans ce cas, autant s'en faire une raison et poser les bons éléments, quels qu'ils soient :
- annoncer clairement que les fonctions sont en constantes évolutions
- proposer les liens vers le code source qui fait référence
- si possible supprimer les infos obsolètes pour ne pas mettre les gens dans l'erreur
Je pense que pour la plupart des scripteurs potentiels, se référer à un code source plutot qu'à une doc html n'est pas un gros obstacle. Bon, en espérant que ce soit codé clairement et avec quelques commentaires (nan pas encore regardé) :p
Sinon vous avez déjà envisagé une génération de doc automatique ? Du genre javadoc ou doxygen... C'est sans doute une bonne piste pour maintenir à jour sans trop d'effort une doc, surtout lorsqu'il s'agit d'un ensemble du type API.
Tu peux aussi regarder le code source de POL/POM pour la liste des
fonctions, elles sont écrites en bash, comme les scripts. Mais pas mal
de ces fonctions ne sont pas utilisées directement dans les scripts.
Alors je suggère pour la page "Documentation" :
- ajouter un lien "Liste des fonctions pour POL_Call" vers
http://www.playonmac.com/repository/?cat=100- ajouter un(des) lien(s) vers les sources de POL/POM (directement vers les fichiers contenant le codes des fonctions, moi là comme ça... je me vois pas fouiller le git pour trouver mon bonheur)
- ajouter un lien vers le forum, en particulier ce post
http://www.playonmac.com/fr/topic-4254-A_propos_des_scripts.html que je n'ai découvert qu'après
- expliquer comment faire pour proposer un script (se créer un compte, poster dans le forum, lien "nouvel installeur" sur la page "Logiciels supportés")
Et sur la page d'accueil, mettre un lien pour "Proposer vos scripts d'installation", qui peut se contenter de pointer vers la page documentation (surtout si celle-ci est bien complété avec le dernier point évoqué).
Un lien pour proposer un script est présent en page "Logiciels supportés".
Je me rends compte que cette page est vraiment centrale. Elle ne permet pas seulement de voir la liste des apps supportées, elle donne aussi l'accès au code source des scripts (ya un autre moyen sinon pour les voir !?).
En plus il y a cette option qui m'avait complétement échappé pour proposer un script (je n'avais pas encore de compte, donc je n'avais pas cette option).
Du coup je trouve qu'elle est peu mise en avant sur le site : juste un petit lien dans le menu de gauche, rien à voir avec les liens du haut bien plus visibles. Mais forcément, difficile de rajouter un lien de plus en haut...
Par contre cette page pourrait au moins être davantage citée dans les autres sections :
- sur la page documentation comme je disais, à la fois pour sa fonction d'ajout de scripts, que pour les possibilités de consulter les scripts existants.
- sur la page téléchargements pourquoi pas ? avec une dernière section "Scripts" (à moins qu'il y ait un meilleur moyen d'accéder aux scripts dispo).
Voila quelques pistes à creuser ;)
Edité par TonyFlow