Contribuer au Wiki de Discord FR
Dans cet article, vous apprendrez pas à pas à créer une page et à la modifier pour devenir un vrai contributeur de ce Wiki. Elle vous expliquera les bases et quelques conseils utiles pour bien débuter.
Comment modifier une page du Wiki
Sélection du Fichier
Rendez-vous sur la page GitHub du Wiki puis choisissez le fichier que vous souhaitez éditer dans la liste.
Note
Les fichiers portent le nom du lien, par exemple contribuer.md est le fichier correspondant au lien https://dfr.gg/wiki/contribuer.
Débuter la modification
Cliquez sur le petit logo de crayon (Modifier), GitHub alors créera automatiquement une "Fork" dans votre profil, ce qui vous permettra de modifier le document.
Valider la modification et la commenter
Après avoir fait vos modifications, veillez à la mettre en page avec du Markdown, vous trouverez une boîte d'aide plus bas ; ajoutez ensuite un commentaire qui explique précisément vos modifications ; vous devez indiquer vos sources si vous en avez. (Numéro 1)
Enfin, validez en appuyant sur le bouton "Propose changes" qui confirmera l'action. (Numéro 2)
Attention !
Même si un membre de l'équipe passe derrière, relisez-vous. Les modifications ayant un nombre trop important de fautes d'orthographes seront écartées.
Vérification et mise en ligne
C'est la dernière fois que vous verrez votre texte ! Relisez-le une dernière fois. (Numéro 1)
Une fois que vous êtes certain du contenu, cliquez sur "Create pull request". (Numéro 2)
Création de la Pull Request
Ici vous pouvez pour la dernière fois modifier le titre et le commentaire d'ajout. Vérifiez s'il est complet et si possible sourcé (un article du support Discord anglophone par exemple). (Numéro 1)
Ensuite pour terminer votre travail, cliquez sur "Create pull request". (Numéro 2)
Attention !
Vous devez laisser coché la case "Allow edits by maintainers" pour nous autoriser la correction de fautes ou tout simplement nous permettre d'ajouter les tags nécessaires pour que les hamsters quantiques de notre site web puissent travailler !
Vérification par l'équipe
Si vous tombez sur la page suivante, vous n'avez plus rien à faire, le staff de Discord FR et les contributeurs chevronnés examinerons votre modification.
Information
Il faudra à l'équipe moins d'une semaine pour examiner votre modification. Cependant, si vous constatez que cela prend plus de temps, vous pouvez directement nous contacter sur Notre Discord en envoyant un Message Privé au bot @Slash FR#9922.
Comment ajouter une page au Wiki
Créer une page vide prête à être remplie
Rendez-vous sur la page GitHub du Wiki, ensuite choisissez "Add File" puis "Create new file".
Ajouter le contenu de base
Comme pour la modification, entrez le contenu initial de la page. Veillez à la mettre en page grâce au Markdown ; vous trouverez une boîte d'aide plus bas dans cet article. (Numéro 1)
Une fois le contenu rempli, indiquez ce que cette page initiale contient, et si possible, ajoutez des sources. (Numéro 2)
Attention !!!
Pensez à nommer votre fichier en haut (wiki/nom). Mettez impérativement .md à la fin du fichier ; sans cela, votre page ne fonctionnera pas et sera rejetée.
Une fois la page correctement remplie, relisez-vous attentivement, puis ensuite cliquez simplement sur "Propose new file". (Numéro 3)
Attention !
Même si un membre de l'équipe passe derrière, relisez-vous. Les modifications ayant un nombre trop important de fautes d'orthographes ou d'erreurs de formulations seront écartés ou demanderont des modifications de votre part.
Vérification et mise en ligne
Encore une fois, c'est la dernière fois que vous verrez votre texte ! Relisez-le une dernière fois. (Numéro 1)
Une fois que vous êtes certain du contenu, cliquez sur "Create pull request". (Numéro 2)
Création de la Pull Request
Ici, vous pouvez pour la dernière fois modifier le titre et le commentaire d'ajout. Vérifiez s'il est complet et si possible sourcé (un article du support Discord anglophone par exemple). Attention ! N'oubliez pas de préciser votre ID d'utilisateur Discord pour que nous puissions garder votre compte de contribution à jour ! (Numéro 1)
Enfin, pour terminer votre travail, cliquez sur "Create pull request". (Numéro 2)
Attention !
Vous devez laisser coché la case "Allow edits by maintainers" pour nous autoriser la correction de fautes ou tout simplement nous permettre d'ajouter les tags nécessaires pour que les hamsters quantiques de notre site web puissent travailler !
Vérification par l'équipe
Si vous tombez sur la page suivante, vous n'avez plus rien à faire, le staff de Discord FR et les contributeurs chevronnées examinerons votre nouvelle page.
Information
Il faudra à l'équipe moins d'une semaine pour examiner votre modification. Cependant, si vous constatez que cela prend plus de temps, vous pouvez directement nous contacter sur Notre Discord en envoyant un Message Privé au bot @Slash FR#9922.
Bonus d'Aide au Markdown
Vous trouverez ci-dessous un petit tableau d'aide au Markdown, vous pouvez aussi aller voir cette Cheat Sheet pour plus de contenu.
| Syntaxe | Résultat |
|---|---|
| # Titre 1 |  |
| ## Titre 2 |  |
| ### Titre 3 |  |
| #### Titre 4 |  |
| ##### Titre 5 |  |
| ###### Titre 6 |  |
| **Gras** | Gras |
| *Italique* | Italique |
| ***Les deux cap'tain*** | Les deux cap'tain |
| > Citation |  |
| - Liste à point |  |
| `code` | code |
| ********************* |  |
| [Site de Discord FR](https://dfr.gg/) | Site de Discord FR |
|  |  |
Bonus pour les nerds
Ajouter les balises Docusaurus dans la création de la page
Vous pouvez faciliter le travail de l'équipe en rajoutant les Balises Docusaurus
Vous pouvez ajouter les balises suivantes :
- title
- keywords
- description
Par exemple, un début de document :
---
title: Contribuer
keywords:
- contribuer
- discord
- wiki
- tutoriel
description: Contribuer est une chose importante pour le Wiki de Discord FR, apprenez comment nous aider sur cette page. :)
---
Astuce
N'hésitez pas à regarder des articles déjà en ligne, pour copier des éléments, comme ces boîtes d'informations ; ou consulter le site de Docusaurus, dont les boîtes sont expliquées dans cet extrait