Guides pratiques pour les contributeur·ice·s MDN
Cette section des règles de rédaction de MDN Web Docs contient les étapes détaillées pour accomplir des tâches spécifiques lors de la contribution à MDN Web Docs : comment utiliser le markdown, comment ajouter une entrée au glossaire, comment déplacer ou supprimer des pages, et plus encore.
Pour savoir comment contribuer, consultez nos directives de contribution.
Ces documents partent du principe que vous avez lu les directives de contribution, que vous connaissez les dépôts mdn/content et mdn/translated-content, et que vous savez utiliser git et GitHub.
- Comment ajouter des images et des médias
Cette page explique comment ajouter des images et des médias aux pages de documentation sur MDN.
- Comment ajouter une entrée de glossaire
Dans cet article, nous allons voir comment ajouter des entrées au glossaire MDN Web Docs et comment y faire référence. Il fournit également des directives sur la mise en page et le contenu des entrées du glossaire. Le glossaire fournit des définitions pour tous les termes, le jargon, les abréviations et les acronymes que vous rencontrez en lisant le contenu de MDN sur le Web et le développement Web.
- Comment créer, modifier, déplacer ou supprimer des pages
Cet article décrit comment créer, déplacer, supprimer ou modifier une page. Dans tous ces cas, il est conseillé de consulter nos directives concernant ce que nous écrivons pour confirmer si l'une de ces actions doit être entreprise et d'en discuter avec l'équipe sur le canal de discussion du MDN Web Docs avant de procéder.
- Comment documenter les erreurs web
La référence des erreurs JavaScript sur MDN Web Docs est un projet visant à aider les développeuses et développeurs web à résoudre les erreurs survenant dans la console web des outils de développement (angl.). Pour ce projet, nous avons besoin d'écrire plus de documentation sur les erreurs sur MDN Web Docs afin que les outils où les messages sont générés puissent renvoyer vers ces pages. Cet article explique comment documenter les erreurs JavaScript.
- Comment documenter un en-tête HTTP
La page de référence des en-têtes HTTP documente la section des en-têtes des messages de requête et de réponse dans le protocole de transfert hypertexte (HTTP). Cet article explique comment créer une nouvelle page de référence pour un en-tête HTTP.
- Comment documenter une propriété CSS
Au fur et à mesure que les normes CSS évoluent, de nouvelles propriétés sont ajoutées. La référence CSS sur MDN Web Docs doit être maintenue à jour avec ces développements. Cet article fournit des instructions pas à pas pour créer une page de référence des propriétés CSS.
- Comment écrire du Markdown
Cette page décrit comment nous utilisons le Markdown pour écrire la documentation sur MDN Web Docs. Nous avons choisi le Markdown personnalisé de GitHub (GFM) comme base, et nous avons ajouté quelques extensions pour supporter certaines choses que nous devons faire sur MDN et qui ne sont pas supportées par GFM.
- Comment rédiger une référence API
Ce guide vous explique tout ce que vous devez savoir pour rédiger une référence API sur MDN.
- Comment s'informer sur une technologie
Cet article vous fournit des informations pratiques sur la manière d'aborder la documentation des technologies.
- Comment utiliser les données structurées
MDN stocke les données dans des structures bien définies lorsque c'est possible. Ces informations sont ensuite centralisées et peuvent être mises à jour une seule fois, tout en étant utilisées à de nombreux endroits.
- Retirer une section de contenu
Cet article décrit le processus de retrait de sections entières du contenu de MDN Web Docs, connu sous le nom de retrait. Le retrait est différent de la suppression ou du déplacement de pages individuelles ; il s'applique lorsqu'une section entière n'est plus activement maintenue, pertinente ou alignée sur les objectifs de MDN et doit être retirée de manière planifiée et transparente. Le contenu retiré n'est pas supprimé de manière permanente — il est toujours archivé dans le dépôt MDN Museum (angl.).