MDN:How to help

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

Revision Content

This page is for MDC users who wish to contribute to the MDC project. It explains what you need to do to become a contributor and how you can help the project.

{{template.Devmo_editor_TOC()}}

Writing Guidelines

We're still in the process of formulating "official" writer's guidelines for the MDC, and what we have decided upon is listed here: MDC:Writer's guide.

Documentation Lists

First, quick links to the lists of documentation we need to write or migrate:

You can also look at the categories listed on MDC:To Do List.

If you have migrated a page from www.mozilla.org and want the original location to redirect to the new location, add the URL to the Needs Redirect page.

Create an Account for yourself

Simply click the Create Account link and fill in the blanks. You have to create an account and login in order to edit pages. This is because it helps fighting vandalism and makes it easier to track (and give credit for) your contributions.

Sign up to the dev-mdc Mailing List

Before you get started, it's recommended that you sign up to the dev-mdc mailing list. All project questions, communication, and coordination are handled through the list, so it's fairly essential that all MDC contributors are signed up there.

Information about the mailing list, as well as about other places, like the #devmo IRC channel, is available at the MDC:Community page.

How you can help

Migrating existing content to the MDC Wiki

First, read the MDC Wiki Markup Reference to get a feel for how markup is done. If you would like to see more concrete examples, check out the Core JavaScript 1.5 Reference -- the Reference isn't perfect, but it should give you a general idea of how we're looking to do things.

Second, read the MDC Page Naming Guide. Page names for this wiki are a little bit complicated if you're doing book-length or similar content, but straightforward for shorter pieces. Again, check out the Core JavaScript 1.5 Reference for examples.

Third, check out the MDC:Existing Content list. The Mozilla.org content we want migrated into the wiki is listed there, with links to their existing locations.

When you're finished, or if you have any problems or questions, just send a note to the mailing list.

Contributing new content

Contributing new content to the MDC wiki is one of the most valuable ways you can help, whether that new content be a whole new book-length piece, or a small-but-well-documented code sample added to an existing page. We love new content.

If you would like to contribute new content, the procedure is pretty straightforward:

First, read the MDC Wiki Markup Reference to get a feel for how markup is done. If you would like to see more concrete examples, check out the Core JavaScript 1.5 Reference -- the Reference isn't perfect, but it should give you a general idea of how we're looking to do things.

Second, read the MDC Page Naming Guide. Page names for this wiki are a little bit complicated if you're doing book-length or similar content, but straightforward for shorter pieces. Again, check out the Core JavaScript 1.5 Reference for examples.

Third, if your content is an addition to an existing page, simply click "Edit" on that page and add your content, marking it up as best you can.

If your content is new and requires a new page, simply create a link to the page you want to create on your user page (click your name in the Navigation bar), then click that link to start writing. When you're ready, add appropriate category links to the bottom of your new page, and it will automatically be included in those categories.

For example, if I wanted to add an article called "A New Approach to JavaScript Rollovers", I would:

1) Go to my user page and click "Edit".

2) I'd then add my article title to the page surrounded by the same wiki-link tags as the rest of the articles, like:

* [[A New Approach to JavaScript Rollovers]]

3) After clicking "Save" on my user page, I'd click on the article title I just added, which should bring me to a new, empty page where I can then add my new content.

4) When finished, I would then add a [[Category:JavaScript:Articles]] category tag at the bottom of the page.

After adding your new content, you're welcome to send a note to the devmo-general mailing list. This will let the rest of the contributors know that there's new content so we can then help with reviewing, editing, and making sure it's in the best location.

Doing technical reviews

If you're a technical expert in any particular area covered by our documentation, your expertise would be very much appreciated in doing technical reviews of the content that exists within the wiki.

Everyone makes mistakes, and no one knows all of the best ways to do everything, so the more eyes we have going over our documentation for technical accuracy and best-practices, the better.

If you find a page that contains technical errors or that could be improved, simply click the "Edit" tab and make whatever changes you see fit. If you need help with markup, there's a MDC Wiki Markup Reference you can reference. Once you're finished making changes, simply "Save" the page to commit those changes to the site.

This category contains articles marked as needing a technical review: Category:NeedsTechnicalReview.

Doing editorial reviews

If you have a strong command of language, grammar, spelling, and writing, your expertise could be best used by editing and improving the overall writing quality of the content in this wiki.

Sometimes writing about technical subjects can be awkward due to the emphasis on accuracy over writing style, so be sure that any changes you make to the writing do not change the technical information being communicated. If you're not sure, feel free to bring it up on the devmo-general mailing list.

Should you find areas that need improvements or fixes (typos, spelling, grammar, clarity, etc) simply click on the "Edit" tab at the top of the page, make whatever changes you see fit, then hit "Save" to commit those changes to the website.

This category contains articles marked as needing an editorial review: Category:NeedsEditorialReview.

Translating documentation

Devmo now has several wikis set up to support translation projects.

Ideally, we would like to have all of our documentation translated to as many languages as possible. If you would like to work on a localization that is not listed here, please see the MDC:Localization Projects page.{{mediawiki.internal('zh-cn:MDC:如何�?�出帮助', "en")}}

{{ wiki.languages( { "de": "Project:de/Wie_kann_ich_helfen?", "fr": "Project:fr/Comment_aider", "nl": "Project:nl/Hoe_Je_Kan_Helpen", "pl": "Project:pl/Jak_pom\u00f3c", "pt": "Project:pt/Como_Ajudar", "ja": "Project:ja/How_to_Help" } ) }}

Revision Source

<p>This page is for MDC users who wish to contribute to the MDC project. It explains what you need to do to become a contributor and how you can help the project.
</p><p>{{template.Devmo_editor_TOC()}}
</p>
<h3 name="Writing_Guidelines"> Writing Guidelines </h3>
<p>We're still in the process of formulating "official" writer's guidelines for the MDC, and what we have decided upon is listed here: <a href="Project:en/Writer's_guide">MDC:Writer's guide</a>.
</p>
<h3 name="Documentation_Lists"> Documentation Lists </h3>
<p>First, quick links to the lists of documentation we need to write or migrate:
</p>
<ul><li> <a href="Project:en/Documentation_Wishlist">MDC:Documentation Wishlist</a>
</li><li> <a href="Project:en/Existing_Content">Mozilla.org Existing Content List</a>
</li><li> <a href="Project:en/Articles_and_Tutorials_Sign-up_List">MDC:Articles and Tutorials Sign-up List</a>
</li></ul>
<p>You can also look at the categories listed on <a href="Project:en/To_Do_List">MDC:To Do List</a>.
</p><p>If you have migrated a page from www.mozilla.org and want the original location to redirect to the new location, add the URL to the <a href="Project:en/Needs_Redirect">Needs Redirect</a> page.
</p>
<h3 name="Create_an_Account_for_yourself"> Create an Account for yourself </h3>
<p>Simply click the <a href="Special:Userlogin">Create Account</a> link and fill in the blanks.  You have to create an account and login in order to edit pages. This is because it helps fighting vandalism and makes it easier to track (and give credit for) your contributions.
</p>
<h3 name="Sign_up_to_the_dev-mdc_Mailing_List"> Sign up to the dev-mdc Mailing List </h3>
<p>Before you get started, it's recommended that you sign up to the dev-mdc mailing list. All project questions, communication, and coordination are handled through the list, so it's fairly essential that all MDC contributors are signed up there.
</p><p>Information about the mailing list, as well as about other places, like the #devmo IRC channel, is available at the <a href="Project:en/Community">MDC:Community</a> page.
</p>
<h3 name="How_you_can_help"> How you can help </h3>
<h4 name="Migrating_existing_content_to_the_MDC_Wiki"> Migrating existing content to the MDC Wiki </h4>
<p>First, read the <a href="Project:en/Wiki_Markup_Reference">MDC Wiki Markup Reference</a> to get a feel for how markup is done.  If you would like to see more concrete examples, check out the <a href="en/Core_JavaScript_1.5_Reference">Core JavaScript 1.5 Reference</a> -- the Reference isn't perfect, but it should give you a general idea of how we're looking to do things.
</p><p>Second, read the <a href="Project:en/Page_Naming_Guide">MDC Page Naming Guide</a>.  Page names for this wiki are a little bit complicated if you're doing book-length or similar content, but straightforward for shorter pieces.  Again, check out the <a href="en/Core_JavaScript_1.5_Reference">Core JavaScript 1.5 Reference</a> for examples.
</p><p>Third, check out the <a href="Project:en/Existing_Content">MDC:Existing Content</a> list.  The Mozilla.org content we want migrated into the wiki is listed there, with links to their existing locations.
</p><p>When you're finished, or if you have any problems or questions, just send a note to the <a href="Project:en/Community">mailing list</a>.
</p>
<h4 name="Contributing_new_content"> Contributing new content </h4>
<p>Contributing new content to the MDC wiki is one of the most valuable ways you can help, whether that new content be a whole new book-length piece, or a small-but-well-documented code sample added to an existing page.  We love new content.
</p><p>If you would like to contribute new content, the procedure is pretty straightforward:
</p><p>First, read the <a href="Project:en/Wiki_Markup_Reference">MDC Wiki Markup Reference</a> to get a feel for how markup is done.  If you would like to see more concrete examples, check out the <a href="en/Core_JavaScript_1.5_Reference">Core JavaScript 1.5 Reference</a> -- the Reference isn't perfect, but it should give you a general idea of how we're looking to do things.
</p><p>Second, read the <a href="Project:en/Page_Naming_Guide">MDC Page Naming Guide</a>.  Page names for this wiki are a little bit complicated if you're doing book-length or similar content, but straightforward for shorter pieces.  Again, check out the <a href="en/Core_JavaScript_1.5_Reference">Core JavaScript 1.5 Reference</a> for examples.
</p><p>Third, if your content is an addition to an existing page, simply click "Edit" on that page and add your content, marking it up as best you can.
</p><p>If your content is new and requires a new page, simply create a link to the page you want to create on your user page (click your name in the Navigation bar), then click that link to start writing.  When you're ready, add appropriate <a href="Special:Tags?tag=All_Categories&amp;language=en">category</a> links to the bottom of your new page, and it will automatically be included in those categories.
</p><p>For example, if I wanted to add an article called "A New Approach to JavaScript Rollovers", I would:
</p><p>1) Go to my <a href="en/Sandbox/Dria">user page</a> and click "Edit".
</p><p>2) I'd then add my article title to the page surrounded by the same wiki-link tags as the rest of the articles, like:
</p>
<pre>* [[A New Approach to JavaScript Rollovers]]
</pre>
<p>3) After clicking "Save" on my <a href="en/Sandbox/Dria">user</a> page, I'd click on the article title I just added, which should bring me to a new, empty page where I can then add my new content.
</p><p>4) When finished, I would then add a <span class="plain">[[Category:JavaScript:Articles]]</span> category tag at the bottom of the page.
</p><p>After adding your new content, you're welcome to send a note to the <a href="Project:en/Community">devmo-general mailing list</a>.  This will let the rest of the contributors know that there's new content so we can then help with reviewing, editing, and making sure it's in the best location.
</p>
<h4 name="Doing_technical_reviews"> Doing technical reviews </h4>
<p>If you're a technical expert in any particular area covered by our documentation, your expertise would be very much appreciated in doing technical reviews of the content that exists within the wiki.
</p><p>Everyone makes mistakes, and no one knows all of the best ways to do everything, so the more eyes we have going over our documentation for technical accuracy and best-practices, the better.
</p><p>If you find a page that contains technical errors or that could be improved, simply click the "Edit" tab and make whatever changes you see fit.  If you need help with markup, there's a <a href="Project:en/Wiki_Markup_Reference">MDC Wiki Markup Reference</a> you can reference.  Once you're finished making changes, simply "Save" the page to commit those changes to the site.
</p><p>This category contains articles marked as needing a technical review: <a href="Special:Tags?tag=NeedsTechnicalReview&amp;language=en">Category:NeedsTechnicalReview</a>.
</p>
<h4 name="Doing_editorial_reviews"> Doing editorial reviews </h4>
<p>If you have a strong command of language, grammar, spelling, and writing, your expertise could be best used by editing and improving the overall writing quality of the content in this wiki.
</p><p>Sometimes writing about technical subjects can be awkward due to the emphasis on accuracy over writing style, so be sure that any changes you make to the writing do not change the technical information being communicated.  If you're not sure, feel free to bring it up on the <a href="Project:en/Community">devmo-general mailing list</a>.
</p><p>Should you find areas that need improvements or fixes (typos, spelling, grammar, clarity, etc) simply click on the "Edit" tab at the top of the page, make whatever changes you see fit, then hit "Save" to commit those changes to the website.
</p><p>This category contains articles marked as needing an editorial review: <a href="Special:Tags?tag=NeedsEditorialReview&amp;language=en">Category:NeedsEditorialReview</a>.
</p>
<h4 name="Translating_documentation"> Translating documentation </h4>
<p>Devmo now has several wikis set up to support translation projects.
</p>
<ul><li> <a class="external" href="http://developer.mozilla.org/ca/docs/">Catalan</a>
</li><li> <a class="external" href="http://developer.mozilla.org/cn/docs/">Chinese (China)</a>
</li><li> <a class="external" href="http://developer.mozilla.org/fr/docs/">French</a>
</li><li> <a class="external" href="http://developer.mozilla.org/de/docs/">German</a>
</li><li> <a class="external" href="http://developer.mozilla.org/ja/docs/">Japanese</a>
</li><li> <a class="external" href="http://developer.mozilla.org/pl/docs/">Polish</a>
</li><li> <a class="external" href="http://developer.mozilla.org/pt/docs/">Portuguese</a>
</li><li> <a class="external" href="http://developer.mozilla.org/ko/docs/">Korean</a>
</li></ul>
<p>Ideally, we would like to have all of our documentation translated to as many languages as possible.  If you would like to work on a localization that is not listed here, please see the <a href="Project:en/Localization_Projects">MDC:Localization Projects</a> page.{{mediawiki.internal('zh-cn:MDC:如何�?�出帮助', "en")}}
</p>{{ wiki.languages( { "de": "Project:de/Wie_kann_ich_helfen?", "fr": "Project:fr/Comment_aider", "nl": "Project:nl/Hoe_Je_Kan_Helpen", "pl": "Project:pl/Jak_pom\u00f3c", "pt": "Project:pt/Como_Ajudar", "ja": "Project:ja/How_to_Help" } ) }}
Revert to this revision