[Contribution Doc] Démarche générale

Bonjour à tous et toutes,

j’ai contribué à la documentation de Yunohost en ajoutant de la documentation à la page d’app de pleroma, mais je ne vois aucun affichage lors de la consultation de la page “online”, quelqu’un a t’il/elle des pistes ?

Plus généralement, quel démarche suivre avec le dépot github ? une fois fait les modification je fais une pull request sur la branche master ? Y a t il une branche de développement de la documentation ? Ou un “how to” sur comment contribuer ?
L’ajout de nouvelles pages est elle soumises à validations ou discussion ?

Merci d’avance, A+

Bonjour,
As-tu consulté et/ou trouvé une réponse sur cette page ?
Je ne suis pas un spécialiste, des habitués du forum ayant contribué à la documentation et/ou au code sauront t’aider bien plus efficacement que moi.
En revanche, je vois des PR de maj de Readme sur la branche test de Pleroma…
Bonne journée !

Merci @anonyme18, je suis partis de la documentation, je penses que j’ai mal détaillé mes questions, dit moi si cela te semble plus claire :

En ce qui concerne la page spécifique de pleroma_fr, il n’y avait pas de documentations de présente (je suis tombé sur la page type incitant à contribution) j’ai donc modifié la page de doc comme indiqué au chapitre Sur le site et un bon samaritain à fait le lien avec les images que j’ai envoyé indépendamment ce qui donne au bout du compte cette page https://github.com/YunoHost/doc/blob/master/app_pleroma_fr.md qui fonctionne bien dans le dépot git.

Mais lorsque je consulte la page de documentation de Pleroma ici : https://yunohost.org/#/app_pleroma_fr je tombe sur … rien. (Copie d’écran ci jointe).


Et ma contribution n’est pas visible, et de plus elle n’est plus modifiable en appuyant sur échap ou sur le bouton Éditer. Je ne sais pas si c’est ma contribution qui a fait cela. Il est aussi possible que ce soit mon ordinateur qui dysfonctionne. Mais je recontre une problématique identique avec mon smartphone.

Depuis, j’ai cloner le depot git de yunohost doc directement sur mon ordi, j’ai ajouter (en locale) une page app_pleroma_fr.md accompagné de captures. j’aimerais savoir maintenant quoi en faire ? Les questions qui me viennent aussi avec ce second problèmes :

  • Y a t il une ligne rédactionnelle ? Dans ma première contribution j’ai fais comme cela me convenait, sous forme un peu tutoriel. J’ai aussi indiqué des liens vers le play store et f-droid, mais cela ne met il pas des apps mobiles pllus en avant que d’autres ?
  • La documentations est peut être à discuter ?

Bref, en espérant que mes eclaircissements fassent que tu puisses m’aider. =)


[EDIT] Après recherche je suis tombé sur cette page : https://yunohost.org/#/project_organization_fr Pas mal d’éclaircissement mais pas de ligne éditorial.

Pour répondre rapidement, le formatage affiché par github lorsque tu écris un document est différent de celui utilisé par l’outil utilisé par la documentation YunoHost. Je suspecte que l’outil n’aime pas certaines balise/caractères de ta documentation.

Quand j’ai écris de la documentation, j’ai procédé ainsi:

  1. Créer une “nouvelle page” sur la documentation qui va servir de bac à sable. (exemple: https://yunohost.org/#/azeghazjkhsdf)
  2. Cliquer sur “Éditer”
  3. Copier le texte d’une page qui fonctionne ou partir de zéro
  4. Remplir petit à petit puis cliquer sur “Aperçu”
    1. Si tout s’affiche correctement, continuer à remplir
    2. Si c’est tout blanc ou l’affichage non désiré, trouver la ligne ou le caractère qui ne va pas et corriger
  5. Une fois que le résultat convient
    1. si tu sais utiliser git, éditer ou créer une nouvelle page dans le dépot de la doc puis la commiter
    2. Directement depuis le site de la doc, éditer la page ou la créer et l’envoyer telle quelle (cette méthode ne permet pas de savoir qui a fait la modification et ne permet pas d’échanger par la suite. C’est à réservé aux petites modifications ou aux personnes ne sachant pas utiliser git)
  6. Il y a des discussion sur le dépôt git par les personnes du groupe doc mais pas uniquement

J’espère que ça sera plus clair ainsi:slightly_smiling_face:

N’hésites pas à noter dans un coin tout ce qui ne va pas pour contribuer à la documentation. J’ai en tête d’écrire une page pour faciliter les contributions sur la documentation car pour le moment, c’est compliqué. J’avais bien galéré pour écrire https://yunohost.org/#/filezilla (pour mettre des encadrés avec les couleurs par exemple)

@Gofannon je te remercie des détails. J’ai commencé à travailler sur le même angle d’attaque. Tu peux trouver la branche git que je développe ici : https://github.com/Plumf/doc/tree/dev-redact-doc
L’idée est de développer trois nouvelles pages au sein de la doc contributeur. cf les derniers commits https://github.com/Plumf/doc/commits/dev-redact-doc

je suis chaud pour en discuter et faire ce travaille à plusieurs plutot que deux en parallèle.

1 Like