MDN:How to help

  • Revision slug: Project:How_to_Help
  • Revision title: MDN:How to help
  • Revision id: 298212
  • Created:
  • Creator: teoli
  • Is current revision? No
  • Comment

Revision Content

Getting started
Do you want to help make MDC even better? Here's how to get started.

The Mozilla Developer Network (MDN) supports the growth and development of Firefox and the web by providing comprehensive, accurate, and up-to-date information about Firefox, Mozilla, and web development technologies. MDN Documentation Center (MDC) is the documentation section of MDN.

If you're looking for technical help, try browsing or searching the site. Technical questions should be directed to one of the Mozilla development forums.

User questions can be asked on one of the end-user support forums.

I found some wrong or out-of-date info. What should I do?

Ideally, it would be great if you would just fix it. MDC is a wiki, after all. For typos and other minor things, it's really quicker to fix it than to tell someone about it.

But that's not always realistic. Maybe you came to MDC to quickly find some info while in the middle of some other task, and you don't want to interrupt your flow. Or maybe you can tell that something's not right, but you don't personally know all the correct info. There are a few ways you can flag a problem to hopefully be fixed by someone else, including Bugzilla and tagging.

Bugzilla

If you don't know what Bugzilla is, you can safely ignore this section. If you're the kind of person who lives and breathes in Bugzilla, you can file a documentation bug. Use these field values:

product
Mozilla Developer Network
component
Documentation requests
URL
The page where you found the problem
Description
As much as you know or have time to describe about the problem and where to find correct information. This can include people ("talk to so-and-so") as well as Web links.

Tagging

If you're not a Bugzilla maven, you can use tags within MDC to flag problems. Here are some of the tags we use, and their meanings:

  • NeedsMarkupWork: the formatting is not standard or not consistent with other pages.
  • NeedsExample: needs one or more illustrative code examples of the item documented.
  • NeedsContent: the item is incomplete and needs to be filled out.
  • NeedsJSVersion: needs information about the version of JavaScript and EcmaScript this item first appears in.
  • NeedsBrowserCompatibility: needs a browser compatibility table or needs the table filled out.
  • MakeBrowserAgnostic: the article is written with a focus on Gecko, when it is actually about a standard function or feature, which should be rewritten to be generic.

To add tags

  1. Login to MDN.
  2. Click Edit to enter editing mode.
  3. Scroll to the bottom of the page.
  4. In the Tags box, type the tag that you want to add. Tags can contain spaces.
  5. Press Enter to accept the tag.
  6. Click Save Changes when you are done.

To remove tags

  1. Login to MDN.
  2. Click Edit to enter editing mode.
  3. Scroll to the bottom of the page.
  4. Click the X next to the tag you want to delete.
  5. Click Save Changes when you are done.

I want to dive in!

If you'd like to help make the content on MDC better, there are several ways you can contribute. You can write new content, copy-edit and correct existing material, or translate material into new languages. Check out Getting started for details.

Documentation

Lists
Documentation wishlist
Editing/review to do list
Migration list
Bugzilla doc-needed list and Notes on doc-needed bugs
Guides
Getting started
Writer's guide
Topic drivers
Page naming guide
Tracking documentation issues
Writing interface reference documentation
Compatibility tables
Disambiguation pages
Starting a new MDC localization
Creating newsgroup summaries
Creating FAQs
Copyrights and licensing
References
MDC style guide
MDC editor guide
Custom CSS classes
Custom templates
External redirects
Needs redirect

View All...

Community

For technical discussions about Mozilla technology, please use one of the Mozilla development forums.

{{ DiscussionList("dev-mdc", "mozilla.dev.mdc") }}

Tools

{{ languages( { "ca": "Project:ca/Com_ajudar-hi", "en": "Project:en/How_to_Help", "el": "Project:el/MDC:Πώς_να_βοηθήσετε", "de": "Project:de", "es": "Project:es/Como_ayudar", "fr": "Project:fr/Comment_aider", "ja": "Project:ja/How_to_Help", "ko": "Project:ko/How_to_Help", "nl": "Project:nl/Hoe_Je_Kan_Helpen", "pl": "Project:pl/Pomoc", "pt": "Project:pt/Como_Ajudar", "ru": "Project:ru/\u041a\u0430\u043a_\u043f\u043e\u043c\u043e\u0447\u044c", "zh-cn": "Project:cn/\u5982\u4f55\u505a\u51fa\u5e2e\u52a9", "zh-tw": "Project:zh_tw/\u5982\u4f55\u5354\u52a9" } ) }}

Revision Source

<div class="callout-box">
  <strong><a href="/en-US/Project:Getting_started">Getting started</a></strong><br />
  Do you want to help make MDC even better? Here's how to get started.</div>
<div>
  <p>The <strong>Mozilla Developer Network</strong> (MDN) supports the growth and development of Firefox and the web by providing comprehensive, accurate, and up-to-date information about Firefox, Mozilla, and web development technologies. MDN&nbsp;Documentation Center (MDC) is the documentation section of MDN.</p>
  <p>If you're looking for technical help, try <a href="/en" title="en">browsing</a> or <a href="/Special:Search" title="Special:Nutch">searching the site</a>. Technical questions should be directed to one of the <a href="http://www.mozilla.org/community/developer-forums.html">Mozilla development forums</a>.</p>
  <p>User questions can be asked on one of the <a class="external" href="http://www.mozilla.org/support/">end-user support forums</a>.</p>
  <h2 id="I_found_some_wrong_or_out-of-date_info._What_should_I_do.3F">I found some wrong or out-of-date info. What should I do?</h2>
  <p>Ideally, it would be great if you would just fix it. MDC is a wiki, after all. For typos and other minor things, it's really quicker to fix it than to tell someone about it.</p>
  <p>But that's not always realistic. Maybe you came to MDC to quickly find some info while in the middle of some other task, and you don't want to interrupt your flow. Or maybe you can tell that something's not right, but you don't personally know all the correct info. There are a few ways you can flag a problem to hopefully be fixed by someone else, including Bugzilla and tagging.</p>
  <h3 id="Bugzilla">Bugzilla</h3>
  <p>If you don't know what Bugzilla is, you can safely ignore this section. If you're the kind of person who lives and breathes in Bugzilla, you can <a href="https://bugzilla.mozilla.org/enter_bug.cgi?product=Mozilla%20Developer%20Network">file a documentation bug</a>. Use these field values:</p>
  <dl>
    <dt>
      product</dt>
    <dd>
      Mozilla Developer Network</dd>
    <dt>
      component</dt>
    <dd>
      Documentation requests</dd>
    <dt>
      URL</dt>
    <dd>
      The page where you found the problem</dd>
    <dt>
      Description</dt>
    <dd>
      As much as you know or have time to describe about the problem and where to find correct information. This can include people ("talk to so-and-so") as well as Web links.</dd>
  </dl>
  <h3 id="Tagging">Tagging</h3>
  <p>If you're not a Bugzilla maven, you can use tags within MDC to flag problems. Here are some of the tags we use, and their meanings:</p>
  <ul>
    <li><strong>NeedsMarkupWork</strong>: the formatting is not standard or not consistent with other pages.</li>
    <li><strong>NeedsExample</strong>: needs one or more illustrative code examples of the item documented.</li>
    <li><strong>NeedsContent</strong>: the item is incomplete and needs to be filled out.</li>
    <li><strong>NeedsJSVersion</strong>: needs information about the version of JavaScript and EcmaScript this item first appears in.</li>
    <li><strong>NeedsBrowserCompatibility</strong>: needs a browser compatibility table or needs the table filled out.</li>
    <li><strong>MakeBrowserAgnostic</strong>: the article is written with a focus on Gecko, when it is actually about a standard function or feature, which should be rewritten to be generic.</li>
  </ul>
  <table border="0" cellpadding="1" cellspacing="1" style="table-layout: fixed; width: 100%;">
    <tbody>
      <tr>
        <td valign="top">
          <h4 id="To_add_tags">To add tags</h4>
          <ol>
            <li>Login to MDN.</li>
            <li>Click Edit to enter editing mode.</li>
            <li>Scroll to the bottom of the page.</li>
            <li>In the Tags box, type the tag that you want to add. Tags can contain spaces.</li>
            <li>Press Enter to accept the tag.</li>
            <li>Click Save Changes when you are done.</li>
          </ol>
        </td>
        <td valign="top">
          <h4 id="To_remove_tags">To remove tags</h4>
          <ol>
            <li>Login to MDN.</li>
            <li>Click Edit to enter editing mode.</li>
            <li>Scroll to the bottom of the page.</li>
            <li>Click the X next to the tag you want to delete.</li>
            <li>Click Save Changes when you are done.</li>
          </ol>
        </td>
      </tr>
    </tbody>
  </table>
  <!--
  <h2 id="Talk_pages">Talk pages</h2>
  <p>Sometimes just adding a tag does not provide sufficient information about a problem for someone else to fix it. You can use the Talk page associated with a content page on MDC to explain more.</p>
  <p>To edit a Talk page:</p>
  <ol>
    <li>In the upper right corner of the page (beneath the MDN header), click This page &gt; Talk page. The corresponding Talk page opens.</li>
    <li>Click the Edit button. The page editor opens.</li>
    <li>Type your comment, explaining what needs to be fixed about the content page.</li>
    <li>Use four tildes in a row (<span class="nowiki">~~~~</span>) to insert a timestamp with your user ID. This tells other people who left the comment, and when.</li>
    <li>Click Save in the editor toolbar when you are done.</li>
  </ol>
-->
  <h2 id="I_want_to_dive_in!">I want to dive in!</h2>
  <p>If you'd like to help make the content on MDC better, there are several ways you can contribute. You can write new content, copy-edit and correct existing material, or translate material into new languages. Check out <a href="/Project:en/Getting_started" title="Project:en/Getting_started">Getting started</a> for details.</p>
</div>
<table class="topicpage-table" style="clear: both;">
  <tbody>
    <tr>
      <td>
        <h2 id="Documentation">Documentation</h2>
        <dl>
          <dt>
            Lists</dt>
          <dd>
            <a href="/en-US/docs/Project:Documentation_Wishlist">Documentation wishlist</a></dd>
          <dd>
            <a href="/en-US/docs/Project:To-do_list">Editing/review to do list</a></dd>
          <dd>
            <a href="/en-US/docs/Project:Existing_Content">Migration list</a></dd>
          <dd>
            <a href="http://bugzilla.mozilla.org/buglist.cgi?keywords=dev-doc-needed">Bugzilla doc-needed list</a> and <a href="/en-US/docs/Project:Notes_on_doc-needed_bugs">Notes on doc-needed bugs</a></dd>
        </dl>
        <dl>
          <dt>
            Guides</dt>
          <dd>
            <a href="/en-US/docs/Project:Getting_started">Getting started</a></dd>
          <dd>
            <a href="/en-US/docs/Project:Writer's_guide">Writer's guide</a></dd>
          <dd>
            <a href="/en-US/docs/Project:Topic_drivers">Topic drivers</a></dd>
          <dd>
            <a href="/en-US/docs/Project:Page_Naming_Guide">Page naming guide</a></dd>
          <dd>
            <a href="/en-US/docs/Project:Tracking_documentation_issues">Tracking documentation issues</a></dd>
          <dd>
            <a href="/en-US/docs/Project:Writing_interface_reference_documentation">Writing interface reference documentation</a></dd>
          <dd>
            <a href="/en-US/docs/Project:Compatibility_tables">Compatibility tables</a></dd>
          <dd>
            <a href="/en-US/docs/Project:Disambiguation">Disambiguation pages</a></dd>
          <dd>
            <a href="/en-US/docs/Project:Localization_Projects">Starting a new MDC localization</a></dd>
          <dd>
            <a href="/en-US/docs/Project:Newsgroup_summaries">Creating newsgroup summaries</a></dd>
          <dd>
            <a href="/en-US/docs/Project:Creating_FAQs">Creating FAQs</a></dd>
          <dd>
            <a href="/en-US/docs/Project:Copyrights">Copyrights and licensing</a></dd>
        </dl>
        <dl>
          <dt>
            References</dt>
          <dd>
            <a href="/Project:En/MDC_style_guide">MDC style guide</a></dd>
          <dd>
            <a href="/Project:En/MDC_editor_guide">MDC editor guide</a></dd>
          <dd>
            <a href="/Project:en/Custom_CSS_Classes">Custom CSS classes</a></dd>
          <dd>
            <a href="/Project:en/Custom_Templates">Custom templates</a></dd>
          <dd>
            <a href="/Project:en/External_Redirects">External redirects</a></dd>
          <dd>
            <a href="/Project:en/Needs_Redirect">Needs redirect</a></dd>
        </dl>
        <p><span class="alllinks"><a href="/Special:Tags" title="Site Tags">View All...</a></span></p>
      </td>
      <td>
        <h2 id="Community">Community</h2>
        <div class="note">
          For technical discussions about Mozilla technology, please use <a class="external" href="http://www.mozilla.org/community/developer-forums.html">one of the Mozilla development forums</a>.</div>
        <p>{{ DiscussionList("dev-mdc", "mozilla.dev.mdc") }}</p>
        <ul>
          <li><a class="link-irc" href="irc://irc.mozilla.org/devmo">#devmo on irc.mozilla.org</a></li>
          <li><a class="link-mailto" href="mailto:eshepherd@mozilla.com">Eric Shepherd, Developer Documentation Lead</a></li>
          <li><a href="/Project:en/Promote_MDC" title="Project:en/Promote_MDC">Promote MDC</a></li>
        </ul>
        <h2 id="Tools">Tools</h2>
        <ul>
          <li><a class="external" href="http://wikipedia.mozdev.org/">Wikipedia toolbar Firefox extension</a></li>
          <li><a class="external" href="http://spellbound.sourceforge.net/">Spellbound spell-checker Firefox extension</a></li>
        </ul>
        <h2 id="Related_Topics">Related Topics</h2>
        <ul>
          <li><a href="/Project:en/Frequently_Asked_Questions" title="Project:en/Frequently_Asked_Questions">MDC FAQ</a></li>
          <li><a class="internal" href="/Special:Tags?tag=MDC_Project&amp;language=en" title="Special:Tags?tag=MDC Project&amp;language=en">MDC project pages</a></li>
        </ul>
      </td>
    </tr>
  </tbody>
</table>
<p>{{ languages( { "ca": "Project:ca/Com_ajudar-hi", "en": "Project:en/How_to_Help", "el": "Project:el/MDC:Πώς_να_βοηθήσετε", "de": "Project:de", "es": "Project:es/Como_ayudar", "fr": "Project:fr/Comment_aider", "ja": "Project:ja/How_to_Help", "ko": "Project:ko/How_to_Help", "nl": "Project:nl/Hoe_Je_Kan_Helpen", "pl": "Project:pl/Pomoc", "pt": "Project:pt/Como_Ajudar", "ru": "Project:ru/\u041a\u0430\u043a_\u043f\u043e\u043c\u043e\u0447\u044c", "zh-cn": "Project:cn/\u5982\u4f55\u505a\u51fa\u5e2e\u52a9", "zh-tw": "Project:zh_tw/\u5982\u4f55\u5354\u52a9" } ) }}</p>
Revert to this revision