Il est important d'avoir une documentation précise, compréhensible et complète.
Notre documentation est stockée sur Gitea, il vous faudra donc un compte pour l'éditer. Vous devrez probablement forquer le dépot pour créer une copie temporaire que vous pourrez éditer (avec le bouton en haut à droite).
Documenter une nouveauté
Si vous voulez démarrer une nouvelle page à partir de zéro, vous pouvez le faire en allant dans le dossier source (et éventuellement dans les autres sous-dossiers) et en cliquant sur le bouton “Créer un nouveau fichier” (en haut de la liste de fichiers).
Entrez son nom : utilisez une version concise du titre, avec des traits d'union comme séparateurs entre les mots, et l'extension html.md .
Ensuite, vous pouvez commencer à l'écrire, en utilisant MarkDown. La documentation doit être écrite en anglais.
En haut de votre fichier, vous pouvez ajouter quelques métadonnées, comme cela :
---
title: 'Le titre de la page
summary: 'Un sommaire de ce qui est expliqué en dessous.
icon: nom-icone
---
Vous pouvez trouver une liste des icônes que vous pouvez utiliser sur cette page.
Améliorer la documentation actuelle
Notre documentation actuelle n'est probablement pas parfaite, et la vérifier aide beaucoup! Cependant, veuillez noter que cette partie s'applique uniquement à la documentation anglaise, si vous voulez améliorer la documentation dans une autre langue, regardez comment la traduire.
Pour réparer les erreurs que vous trouvez, vous aurez besoin de dupliquer la documentation (comme expliqué dans le premier paragraphe de la partie précédente).
Une fois que c'est fait, choisissez la page que vous voulez vérifier et trouvez le fichier correspondant sur Gitea (Normalement l'URL du fichier dans la documentation et son nom sont les mêmes). Lisez la page pour voir si vous pouvez trouver des typos, des erreurs de grammaire, des phrases qui peuvent être améliorées, etc. Si vous voyez quoi que ce soit qui peut être amélioré, allez sur Gitea et éditez le fichier.
Sauvegarder votre travail et proposer vos modifications
Une fois que vous avez terminé, vous pouvez sauvegarder votre travail. Pour ce faire, Gitea vous demande de faire un bref résumé de vos modifications.
Une fois que vous avez enregistré votre nouveau fichier, vous devrez nous proposer les modifications. Pour cela, vous devrez créer une nouvelle pull request, c'est un espace où nous pouvons discuter de vos changements si nécessaire, puis les accepter. Pour ce faire, utilisez le bouton “Pull request”.
Vous pouvez normalement laisser les paramètres par défaut (modifier éventuellement le titre et la description si vous le souhaitez), et appuyez sur le bouton “Create a pull request”.