mozilla

Revision 516643 of Contributing to MDN

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

Revision Content

Welcome! By visiting this page you have 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.
Does this belong on MDN?
If you're trying to decide if a particular document (or set of documentation) should be on MDN, check out this article, which can help you decide.
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.
Cross-team collaboration tactics for documentation
A guide to helping development teams and the MDN team work well together to ensure the best possible documentation output.
Maintaining content
Other content management tasks, including how to go about having pages deleted.
Using advanced search
The advanced search mechanism makes it possible to search the source code of pages, rather than the resulting page as displayed. This lets you find uses of specific macros, HTML attributes, and CSS styles when you're working on correcting or updating content.
Custom macros
Documentation for most (probably not all) of our custom macros used to automatically generate content; most are simple, some are incredibly powerful.
Working with the community
Tips and techniques to working with our community, including both writers and developers.
Documentation planning and tracking
A guide to the tools and pages we use to plan and track our documentation work.
Zone administration
A zone is a segment of content on MDN whose pages are presented with some added user interface elements, including a special "zone navigation" box and enhanced visuals in the page header area. This article provides information on how to create and manage a zone.

View All...

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. (list of open documentation issues)
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!

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 write articles 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.
Install the MDN WordPress plugin
The Promote MDN WordPress plugin automatically links keywords and phrases to MDN to help your blog readers discover MDN's valuable content. It also includes a sidebar widget, and the ability to notify Mozilla Press & Developer Relations teams of your post.

{{CommunityBox("Mozilla Developer Network", "dev-mdc", "mozilla.dev.mdc", "mdn", "Meetings|https://wiki.mozilla.org/MDN/Community_meetings/|Biweekly community meeting|We meet every other Wednesday to discuss documentation on MDN. Please join us!")}}

Revision Source

<p>Welcome! By visiting this page you have 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/Does_this_belong">Does this belong on MDN?</a></dt>
   <dd>
    If you're trying to decide if a particular document (or set of documentation) should be on MDN, check out this article, which can help you decide.</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/Cross-team_collaboration_tactics_for_documentation">Cross-team collaboration tactics for documentation</a></dt>
   <dd>
    A guide to helping development teams and the MDN team work well together to ensure the best possible documentation output.</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/Advanced_search">Using advanced search</a></dt>
   <dd>
    The advanced search mechanism makes it possible to search the source code of pages, rather than the resulting page as displayed. This lets you find uses of specific macros, HTML attributes, and CSS styles when you're working on correcting or updating content.</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/Working_with_the_community" title="/en-US/docs/Project:MDN/Contributing/Working_with_the_community">Working with the community</a></dt>
   <dd>
    Tips and techniques to working with our community, including both writers and developers.</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>
   <dt>
    <a href="/en-US/docs/Project:MDN/Contributing/Zones" title="/en-US/docs/Project:MDN/Contributing/Zones">Zone administration</a></dt>
   <dd>
    A zone is a segment of content on MDN whose pages are presented with some added user interface elements, including a special "zone navigation" box and enhanced visuals in the page header area. This article provides information on how to create and manage a zone.</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>
 </div>
 <div class="section">
  <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. (<a href="https://bugzilla.mozilla.org/buglist.cgi?product=Developer%20Documentation&amp;bug_status=__open__">list of open documentation issues</a>)</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>
  <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>
    <a href="https://developer.mozilla.org/en-US/docs/Project:MDN/Contributing/Editor_guide/Live_samples" title="/en-US/docs/Project:MDN/Contributing/Editor_guide#Using_the_live_sample_system">Write live code examples</a></dt>
   <dd>
    Add code examples to MDN, where readers can view and modify the code and observe the results.</dd>
   <dt>
    <a href="https://support.mozilla.org/get-involved/kb" title="https://support.mozilla.org/get-involved/kb">Write end-user documentation</a></dt>
   <dd>
    If you'd rather write for users than developers, you can help write articles on the Firefox Support site (also known as SUMO).</dd>
   <dt>
    <a href="/en-US/demos" title="/en-US/demos">Create demos</a></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>
    <a href="/en-US/docs/Project:MDN/Kuma/Contributing" title="/en-US/docs/Project:MDN/Kuma/Contributing">Improve the MDN platform</a></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>
    <a href="http://wordpress.org/plugins/promote-mdn/installation/" target="_blank" title="Install the MDN WordPress plugin">Install the MDN WordPress plugin</a></dt>
   <dd>
    The Promote MDN WordPress plugin automatically links keywords and phrases to MDN to help your blog readers discover MDN's valuable content. It also includes a sidebar widget, and the ability to notify Mozilla Press &amp; Developer Relations teams of your post.</dd>
   <!--
    <dt>
      <a href="http://www.firefoxflicks.org" title="http://www.firefoxflicks.org">Make a movie!</a></dt>
    <dd>
      <span class="userContent">Firefox Flicks is a global video contest about the power of mobile. Enter for your chance to be seen by celebrity judges and win some amazing prizes. Or, if you h<span class="userContent">ave friends or colleagues who love movies or moviemaking, tell them about Firefox Flicks. Find out more at</span> <a href="http://www.firefoxflicks.org/" rel="nofollow nofollow">www.firefoxflicks.org</a></span>. The final deadline is July 31, 2013, but early entries are eligible for additional awards.</dd>

      <dt>
        <a href="https://webmaker.org/party/" title="/https://webmaker.org/party/"><span class="userContent">Get excited and make something!</span></a></dt>
      <dd>
        From June 15 to September 15, 2013, thousands of people around the world are meeting up, making cool stuff and teaching others at the 2013 Mozilla Maker Party.</dd>
-->
  </dl>
 </div>
</div>
<p>{{CommunityBox("Mozilla Developer Network", "dev-mdc", "mozilla.dev.mdc", "mdn", "Meetings|https://wiki.mozilla.org/MDN/Community_meetings/|Biweekly community meeting|We meet every other Wednesday to discuss documentation on MDN. Please join us!")}}</p>
Revert to this revision