mozilla

Revision 428013 of Contributing to MDN

  • Revision slug: Project:MDN/Contributing
  • Revision title: Contributing to MDN
  • Revision id: 428013
  • Created:
  • Creator: jswisher
  • Is current revision? No
  • Comment

Revision Content

Welcome! By visiting this page, you've taken the first step toward becoming a contributor to MDN. Here you'll find guides to get you started as a new contributor to MDN, information about how our tools work, and so forth.

MDN contributor guide

Getting started
A getting started guide for new MDN contributors.
How you can help
A guide to things you can do to help, from the easy to the intricate.
Creating and editing pages
How to create new pages as well as how to edit existing content.
MDN editor guide
A complete guide to editing on MDN, including detailed documentation of the editor, the template system, and more.
MDN tagging standards
In order to ensure MDN's content is as useful as possible, we have guidelines to help you apply the most useful tags possible to pages.
Maintaining content
Other content management tasks, including how to go about having pages deleted.
Custom macros
Documentation for most (probably not all) of our custom macros used to automatically generate content; most are simple, some are incredibly powerful.
Documentation planning and tracking
A guide to the tools and pages we use to plan and track our documentation work.

View All...

The links on this page assume that you are writing developer documentation. If that's not your cup of tea, here are some other, related ways to contribute to Mozilla.

Write live code examples
Add code examples to MDN, where readers can view and modify the code and observe the results.
Write end-user documentation
If you'd rather write for users than developers, you can help out on the Firefox Support site (also known as SUMO).
Create demos
If you've written a self-contained demo that shows off current standards-based Web technologies, you can submit it to the Demo Studio on MDN, to show it off to the world.
Improve the MDN platform
The wiki platform that powers MDN is known as "Kuma", and is open source software, just like everything else at Mozilla. You can help fix bugs and implement new features.
 

 

OtherMDN community

Want to participate in the discussion about documentation on MDN? Our community talks all the time on IRC!

Don't forget about the netiquette...

Tools and tasks

Request developer documentation
Our developer documentation request form lets you request new documentation or updates to existing documentation. The form guides you through presenting the needed information and helps to ensure that your request will be handled as soon as possible.
Team status board
A look at what members of the team are working on right now. We encourage all contributors to keep their information here current; out-of-date entries will be purged regularly.
Things to do
We have several lists of different types of things you can to do help. Refer to these lists to find content you can add or improve.
Plans and ideas
A collection of documents with plans and ideas for organization work on MDN, future plans, and so forth. Herein there be dragons; tread with care!

 

Revision Source

<p>Welcome! By visiting this page, you've taken the first step toward becoming a contributor to MDN. Here you'll find guides to get you started as a new contributor to MDN, information about how our tools work, and so forth.</p>
<div class="row topicpage-table">
  <div class="section">
    <h2 class="Documentation" id="Documentation" name="Documentation">MDN contributor guide</h2>
    <dl>
      <dt>
        <a href="/en-US/docs/Project:MDN/Contributing/Getting_started" title="/en-US/docs/Project:MDN/Contributing/Getting_started">Getting started</a></dt>
      <dd>
        A getting started guide for new MDN contributors.</dd>
      <dt>
        <a href="/en-US/docs/Project:MDN/Contributing/How_to_help" title="/en-US/docs/Project:MDN/Contributing/How_to_help">How you can help</a></dt>
      <dd>
        A guide to things you can do to help, from the easy to the intricate.</dd>
      <dt>
        <a href="/en-US/docs/Project:MDN/Contributing/Creating_and_editing_pages" title="/en-US/docs/Project:MDN/Contributing/Creating_and_editing_pages">Creating and editing pages</a></dt>
      <dd>
        How to create new pages as well as how to edit existing content.</dd>
      <dt>
        <a href="/en-US/docs/Project:MDN/Contributing/Editor_guide" title="/en-US/docs/Project:MDN/Contributing/Editor_guide">MDN editor guide</a></dt>
      <dd>
        A complete guide to editing on MDN, including detailed documentation of the editor, the template system, and more.</dd>
      <dt>
        <a href="/en-US/docs/Project:MDN/Contributing/Tagging_standards" title="/en-US/docs/Project:MDN/Contributing/Tagging_standards">MDN tagging standards</a></dt>
      <dd>
        In order to ensure MDN's content is as useful as possible, we have guidelines to help you apply the most useful tags possible to pages.</dd>
      <dt>
        <a href="/en-US/docs/Project:MDN/Contributing/Maintaining_content" title="/en-US/docs/Project:MDN/Contributing/Maintaining_content">Maintaining content</a></dt>
      <dd>
        Other content management tasks, including how to go about having pages deleted.</dd>
      <dt>
        <a href="/en-US/docs/Project:MDN/Contributing/Custom_macros" title="/en-US/docs/Project:MDN/Contributing/Custom_macros">Custom macros</a></dt>
      <dd>
        Documentation for most (probably not all) of our custom macros used to automatically generate content; most are simple, some are incredibly powerful.</dd>
      <dt>
        <a href="/en-US/docs/Project:MDN/Contributing/Planning" title="/en-US/docs/Project:MDN/Contributing/Planning">Documentation planning and tracking</a></dt>
      <dd>
        A guide to the tools and pages we use to plan and track our documentation work.</dd>
    </dl>
    <p><span class="alllinks"><a href="/en-US/docs/tag/MDC_Project" title="/en-US/docs/tag/CSS">View All...</a></span></p>
    <h2 class="Related_Topics" id="Related_Topics" name="Related_Topics">Other ways to contribute</h2>
    <p>The links on this page assume that you are writing developer documentation. If that's not your cup of tea, here are some other, related ways to contribute to Mozilla.</p>
    <dl>
      <dt>
        Write live code examples</dt>
      <dd>
        Add code examples to MDN, where readers can view and modify the code and observe the results.</dd>
      <dt>
        Write end-user documentation</dt>
      <dd>
        If you'd rather write for users than developers, you can help out on the Firefox Support site (also known as SUMO).</dd>
      <dt>
        Create demos</dt>
      <dd>
        If you've written a self-contained demo that shows off current standards-based Web technologies, you can submit it to the Demo Studio on MDN, to show it off to the world.</dd>
      <dt>
        Improve the MDN platform</dt>
      <dd>
        The wiki platform that powers MDN is known as "Kuma", and is open source software, just like everything else at Mozilla. You can help fix bugs and implement new features.</dd>
      <dt>
        &nbsp;</dt>
    </dl>
  </div>
  <div class="section">
    <br />
    <h2 class="Community" name="Community">&nbsp;</h2>
    <h2 class="Community" id="Community" name="Community">OtherMDN community</h2>
    <p>Want to participate in the discussion about documentation on MDN? Our community talks all the time on IRC!</p>
    <ul>
      <li>Consult the developer documentation forum: {{DiscussionList("dev-mdc", "mozilla.dev.mdc")}}</li>
      <li>Join our biweekly developer <a href="https://wiki.mozilla.org/MDN/Community_meetings/" title="https://wiki.mozilla.org/MDN/Community_meetings/">documentation community meeting</a></li>
    </ul>
    <p><span class="alllinks"><a class="external" href="http://www.catb.org/~esr/faqs/smart-questions.html" title="http://www.catb.org/~esr/faqs/smart-questions.html">Don't forget about the <em>netiquette</em>...</a></span></p>
    <h2 class="Tools" id="Tools" name="Tools">Tools and tasks</h2>
    <dl>
      <dt>
        <a href="https://bugzilla.mozilla.org/form.doc" title="https://bugzilla.mozilla.org/form.doc"><span class="external">Request developer documentation</span></a></dt>
      <dd>
        Our developer documentation request form lets you request new documentation or updates to existing documentation. The form guides you through presenting the needed information and helps to ensure that your request will be handled as soon as possible.</dd>
      <dt>
        <a href="/en-US/docs/Project:MDN/Contributing/Team_status" title="/en-US/docs/Project:MDN/Contributing/Team_status">Team status board</a></dt>
      <dd>
        A look at what members of the team are working on right now. We encourage all contributors to keep their information here current; out-of-date entries will be purged regularly.</dd>
      <dt>
        <a href="/en-US/docs/Project:MDN/Things_to_do" title="/en-US/docs/Project:Things_to_do">Things to do</a></dt>
      <dd>
        We have several lists of different types of things you can to do help. Refer to these lists to find content you can add or improve.</dd>
      <dt>
        <a href="/docs/Project:MDN/Plans" title="/docs/Project:MDN/Plans">Plans and ideas</a></dt>
      <dd>
        A collection of documents with plans and ideas for organization work on MDN, future plans, and so forth. Herein there be dragons; tread with care!</dd>
    </dl>
  </div>
</div>
<p>&nbsp;</p>
Revert to this revision