mozilla
Vos résultats de recherche

    Comment aider

    Il existe de nombreuses manières de contribuer à Mozilla Developer Network, et certaines ne nécessitent pas de compétences rédactionnelles. Ici vous trouverez un excellent guide vous présentant les différentes choses auxquelles vous pouvez apporter votre aide, ainsi qu'une liste de sujets plus spécifiques qui nécessitent de l'attention. Que vous soyez un programmeur, un développeur acharné de Firefox ou un développeur Web ayant des millions de supporters sur Twitter, vous trouverez une manière d'améliorer MDN.

    Comment puis-je aider ?

    Voici quelques suggestions de sujets auxquels vous pouvez apporter votre aide, en fonction du type d'utilisateur de MDN que vous êtes.

    Signaler un problème

    Alors que vous lisez tranquilement MDN, il est possible que vous remarquiez quelques erreurs. Les erreurs peuvent être de différents types, comme du contenu manquant ou imprécis, une syntaxe confuse, un formattage sub-optimal ou des exemples qui ne semblent pas fonctionner. Puisque MDN est un wiki, la meilleure des choses à faire est de corriger le problème vous-même si vous en êtes capables. Mais si vous ne connaissez pas la réponse ou êtes occupés par autre chose, notez cela quelque part afin de le signaler à quelqu'un plus tard.

    Comme usuellement à Mozilla, vous reportez un problème de document en remplissant un bogue de demande de documentation. Notre formulaire va se charger de rassembler les informations nécessaires pour que nous puissions nous charger de corriger le soucis.

    Bien sûr, notre équipe d'auteurs est très occupée, et la manière la plus rapide d'apporter une correction est souvent de l'appliquer vous-même.

    Corriger une erreur

    Parmi les choses les plus faciles à faire est d'aider à corriger du contenu existant. Si vous voyez quelque chose qui est faux, corrigez-le ! Si vous pensez que quelque chose manque de clarté, tentez d'améliorer la syntaxe. Nous adorons quand des personnes corrigent des coquilles et font même les plus petites choses à gauche et à droite sur MDN, car ce sont aussi ces choses qui font la qualité de MDN.

    Quelques ressources utiles :

    Ajouter ou mettre à jour des étiquettes

    Les étiquettes (Tags) sur les pages aident à organiser l'information et nous aident à identifier quelles pages ont besoin de plus d'attention. Les étiquettes sont aussi utilisées pour marquer les pages obsolètes et qui auraient besoin d'être dépréciées ou supprimées. Des étiquettes claires sont une aide très importante, et vous pouvez aider !

    Il existe différents problèmes avec les étiquettes que vous pouvez aider à corriger :

    Aucune étiquette
    Tous les articles devraient avoir au moins une étiquette, et habituellement plusieurs. À minima, les articles devraient avoir une étiquette de « catégorie » et une étiquette de « sujet ». Habituellement, d'autres étiquettes peuvent aussi s'appliquer, mais vous pouvez nous aider à nous assurer qu'au moins ces deux là sont présentes, et vous seriez un héros de la documentation !
    Étiquettes incorrectes
    Si vous lisez un article à propos de HTML, mais qu'il a une étiquette « JavaScript », c'est que quelque chose c'est mal passé. De même, si un article traite des entrailles de Mozilla mais a une étiquette « Web », c'est probablement une erreur également. Retirez ces étiquettes (et si elles manquent, ajoutez les pertinentes). Ce genre de problème couvre aussi les étiquettes contenant des coquilles comme « JavaScrpit » ou « Javascript » par exemple (en réalité le dernier correspondra, du fait que les étiquettes ne soient pas sensibles à la case, mais ce n'est pas correct pour autant !)
    Étiquettes manquantes
    Si un article a quelques étiquettes, mais pas toutes celles qui sont pertinentes, n'hésitez pas à en ajouter. Une page dans la référence JavaScript qui a l'étiquette « JavaScript » (qui est correcte) mais pas d'autre étiquette, devrait aussi avoir l'étiquette « Référence ». N'hésitez pas à l'ajouter !
    Du spam d'étiquettes
    Le plus révoltant des soucis avec les étiquettes : le spam. La vermine du Web a déposé des étiquettes sur certaines pages (du type « Films gratuits » et autres commentaires). Ceci doit disparaître !

    Si vous voyez un (ou plusieurs) de ces problèmes, vous pouvez apporter votre aide en vous connectant sur MDN, puis cliquez sur le bouton Modifier en haut à droite d'une page MDN. Une fois que l'éditeur est chargé, dirigez-vous en bas de la page pour trouver le champ de saisie des étiquettes. Pour plus de détails concernant l'interface de saisie des étiquettes, référez-vous à « Le champ étiquettes » dans guide d'édition MDN.

    Ajouter ou mettre à jour du contenu

    Il existe toujours du contenu qui peut être ajouté ou mis à jour sur MDN. Que cette documentation soit à propos d'une API flambant neuve ou une mise à jour concernant une API plus ancienne qui a connu certaines évolutions, vous trouverez de nombreuses manières d'aider.

    Modifier une page existante

    Si vous avez identifié une page à corriger, cliquez tout simplement sur le bouton Modifier dans le coin supérieur droit, ceci ouvrira un éditeur WYSIWYG afin de modifier le contenu de la page. Référez-vous au guide d'édition MDN pour plus de détails sur le fonctionnement de l'éditeur, ainsi que le système de macro que nous utilisons afin d'automatiser la construction et le formattage du contenu.

    Il existe une multitude de raisons pour modifier une page :

    • Vous avez repéré une erreur ou une coquille.
    • Vous souhaitez reformuler quelque chose pour que ce soit plus facilement compréhensible.
    • La mise en page ou le formattage de la page manque de clarté.
    • L'API documentée a changé et la documentation a besoin d'une mise à jour.
    • Vous souhaiteriez apporter de l'information à propos des différents comportements entre navigateurs par rapport à une API.
    • Vous souhaitez ajouter ou améliorer des exemples de code. Référez-vous à Ajouter un exemple de code ci-dessous pour plu de détails.
    • L'article est un brouillon, ou des détails importants ne sont pas mentionnés.

    Ajouter une nouvelle page

    Voici la pièce de résistance ! Ajouter une nouvelle page à MDN vous attirera l'infinie gratitude du Web. Il existe de nombreuses raisons pour créer une nouvelle page, telles que la documentation d'une nouvelle API ou l'ajout d'un tutoriel ou d'un guide sur un sujet donné.

    Plusieurs voix sont possibles pour créer une page sur MDN une fois que vous vous êtes connectés :

    Cliquer sur un lien d'une « page manquant »
    Lorsque vous naviguez sur MDN, vous trouverez, à l'occasion, des liens vers des pages qui n'existent pas encore. Lorsque nous créons des articles, nous incluons des liens vers des pages qui doivent être créées dans un futur proche. Ceci nous aide à garder une trace de ce qu'il nous reste à faire, même si cela prend un peu de temps. Alors n'hésitez pas à les prendre en main ! En cliquant sur ces liens vous serez redirigés instantannément vers l'éditeur de la nouvelle page.
    Créer une sous-page
    Près du coin supérieur droit de chacun des articles, il y a un menu déroulant « Cette page ». Dans ce menu, il y a une option « Nouvelle sous-page ». En cliquant sur cette option, une nouvelle page « fille » est créée dans la hiérarchie de la documentation. Il suffit de définir le titre et son identifiant, puis de s'attaquer au contenu.
    Créer un clone
    Vous pouvez également cloner une page existante en utilisant l'option « Cloner cette page » dans le menu déroulant « Cette page ». En cliquant sur cette option, vous créez une copie de la page courante, dont le parent est identique et ouvre cette page dans l'éditeur où vous pouvez modifier l'identifiant et le titre de la page. C'est généralement une bonne manière pour ajouter une nouvelle page dans une référence, puisqu'elle permet de reprendre la mise en page à l'identique.
    Créer un lien vers une page inexistante, puis cliquer dessus
    C'est une méthode hybride. Puisqu'une page doit être accessible depuis un certain endroit, vous pouvez démarrer par créer un lien vers un nouvel article dans une page existante, puis cliquer sur le lien que vous avez inséré pour ouvrir l'édition du nouvel article.

    Note : si vous n'êtes pas connectés, vous verrez une erreur 404 lorsque vous essayerez de visiter une page inexistante au lieu de vous voir proposer de l'éditer.

    Révisions de contenu

    Lorsque les auteurs ajoutent ou modifient des articles, ils ont la possibilité de signaler la nécessité d'une révision de l'article. C'est-à-dire qu'ils indiquent que quelqu'un d'autre devrait donner un second regard afin de s'assurer de la qualité de l'article. Il existe trois types de révisions :

    Révision technique
    Une révision technique consiste à faire valider le contenu par quelqu'un ayant des connaissances étendues sur le sujet abordé par l'article. Ils font alors des notes et les envoient à l'auteur ou font les modifications eux-mêmes (la dernière approche étant préférable).
    Révision éditoriale
    Une révision éditoriale consiste en une relecture ciblant les coquilles, les erreurs grammaticales ainsi que le formattage et la mise en page. Ceci inclue le fait que l'article suive la charte de style MDN.
    Révision de macros
    MDN utilise les macros (parfois appelées « template » ou « modèle ») pour automatiser la génération de contenu. Ce JavaScript exécuté par le serveur utilise quelques additions, parfois nommées KumaScript. Les utilisateurs ayant les droits de modification des macros peuvent utiliser les révisions de macros pour demander un second regard sur leur regard.

    Les articles ayant besoin d'une révision ont un ou plusieurs de ces bandeaux en haut de leur page :

    Screen shot: Review banners

    Votre mission (si vous l'acceptez) est de lire l'article et de réviser son contenu. Bien évidemment, vous ne devriez faire de révision technique que de technologies que vous connaissez bien, et de manière similaire, ne faire de révision éditoriale que si vous maîtrisez relativement bien la langue de l'article.

    Trouver des articles à réviser

    Bien que vous puissiez tomber au hasard sur une page ayant besoin de révision, il est possible d'obtenir une liste des articles signalés :

    Révision rapide

    Si vous avez lu un article et qu'il n'y a pas de problème particulier, pas besoin d'ouvrir l'éditeur et de marquer comme révisé. Alternativement, vous pouvez utiliser le champ de révision rapide en bas de la page. Il ressemble à cela :

    Screen shot: Quick review box

    Il vous suffit de cocher les cases pour les révisions que vous avez réalisées et cliquer sur « template ». Si vous n'êtes pas connecté à MDN, vous serez invités à le faire. Puis vous pourrez mettre à jour le statut des révisions.

    Révision dans l'éditeur

    D'autre part, il est possible qu'en procédant à la révision du document, vous ayez apporté des modifications à l'article. Vous êtes donc dans l'éditeur, et pouvez signaler les révisions que vous avez réalisées ici également :

    Screen shot: In-editor review box

    Dans ce cas, vous devez décocher les cases pour les révisions que vous avez réalisées.

    Ajouter un exemple de code

    Puisque le rôle principal de ce site Web est de mettre à disposition de la documentation pour les développeurs, des exemples de codes sont une part inévitable de ce que nous faisons. Ajouter ou améliorer des exemples de codes sont une très bonne manière d'aider nos lecteurs et aussi de contribuer si vous êtes plus programmeur qu'auteur !

    MDN accepte les exemples de codes en direct. Ces exemples utilisent HTML, CSS ou JavaScript et sont insérés dans un article pour s'afficher dans un <iframe> indépendant permettant à l'utilisateur d'essayer votre exemple en direct, sans avoir besoin de naviguer dans du code source pour comprendre comment l'exemple fonctionne.

    Référez-vous à « Utiliser les exemples en direct » dans le guide de l'éditeur MDN pour plus de détails.

    Remarques spécifiques

    Il arrive parfois qu'un article contienne des remarques spécifiques. Cela peut être rendu nécessaire parce que la technologie est obsolète, ou expérimentale et ne devrait pas être utilisée en production. Cette section couvre les cas les plus courants et ce qu'il faut faire.

    Dans la majorité des cas, vous pouvez appliquer ces remarques en ajoutant un appel à une macro pour insérer la bannière appropriée dans le contenu, en ajoutant une étiquette à la page. De plus, si cette page contient un tableau de compatibilité (la plupart des références d'API le font par exemple), vous devrez mettre à jour ce tableau afin qu'il reflète les changement de compatibilité.

    Pour procéder à cela, vous devez ouvrir votre éditeur, et insérer un appel à une macro en haut de l'article, et modifier le tableau de compatibilité (s'il y a une). Le tableau doit apparaître proche de la fin de l'article. Une fois que ceci est fait, allez en bas de la page et ajoutez les étiquettes nécessaires. Enfin, cliquez sur le bouton Enregistrer les modifications qui se situe en haut de la page. La bannière que vous avez choisi doit apparaître en haut de la page, et les macros listant les articles qui sont à jour sauront désormais que votre page documente quelque chose d'obsolète.

    Il peut arriver que vous ayez besoin de signaler un simple élément dans une liste ou dans une table, comme obsolète, déprécié ou autre. Il existe des versions spécifiques des macros pour cela. Il suffit de modifier « _header » par « _inline » à la fin du nom de la macro.

    Contenu obsolète

    Si vous rencontrez un article dont le contenu est obsolète, ce qui veut dire que tout cette page est périmé et ne devrait pas être utilisé, vous devez signaler cette page en ajoutant la macro obsolete_header en haut de la page. Ouvrez simplement la page dans l'éditeur et insérez ceci en haut de l'article :

    {{obsolete_header}}

    Il est aussi nécessaire d'ajouter l'étiquette « Obsolète » à la liste des étiquettes en bas de page.

    Note : si l'article aborde une technologie propre à Mozilla, vous pouvez utiliser la version de Gecko à laquelle cette technologie à été retirée en tant que paramètre de la macro obsolete_header de la manière suivante :

    {{obsolete_header(21)}}

    Ainsi, la bannière spécifiera que la technologie est obsolète depuis Gecko 21, avec un lien vers Firefox 21 pour les développeurs.

    Contenu déprécié

    Le contenu déprécié est du contenu qui aborde une technologie ou une idée qui sera obsolète dans un certain temps. Elle ne fait plus partie d'une recommandation, et sera retirée des navigateurs dans un futur proche. Vous pouvez marquer les pages comme dépréciées en utilisant la macro deprecated_header. Tout comme le contenu obsolète, vous pouvez spécifier la version Gecko à laquelle la technologie à été dépréciée en paramètre, si la technologie est propre à gecko.

    Il est aussi nécessaire d'ajouter l'étiquette « Déprécié ».

    Contenu non-standard

    Le contenu non-standard concerne tout le contenu qui ne fait pas partie d'un standard du Web. Ceci inclut les technologies qui ne sont pas encore arrivé au niveau de brouillon de travail, même si elle est implémentée par plusieurs navigateurs. Vous devez utiliser la macro non-standard_header sur les pages, et l'étiquette « Non-standard ».

    Technologies expérimentales

    Ceci concerne les technologies qui sont à un stade expérimental, et sont tellement à la pointe qu'elles rendent les développeurs nerveux. Vous devez signaler ces pages à l'aide de la macro SeeCompatTable. Celle-ci explique que la technologie n'est pas assez stable pour être utilisée et conseille de consulter le tableau de compatibilité pour plus de détails concernant le supports des navigateurs. Elle n'a pas besoin de paramètres, et va générer un lien pour vous.

    Ceci est très utile pour les implémentations précoces de technologies alors que les brouillons sont aux premiers brouillons voire même sans brouillon de spécification.

    Étiquettes et contributeurs liés au document

    Étiquettes : 
    Contributors to this page: Delapouite, tregagnon, pi_free, FredB
    Dernière mise à jour par : Delapouite,