MDN:How to help

  • Revision slug: Project:How_to_Help
  • Revision title: MDN:How to help
  • Revision id: 18729
  • Created:
  • Creator: Dria
  • Is current revision? No
  • Comment /* How to Help: Contributing new content */

Revision Content

Sign up to the DevMo-General Mailing List

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

How to Help: Migrating DevEdge content to the DevMo Wiki

First, read the DevMo 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 DevMo 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 DevEdge:Priority Content list. The priority DevEdge content we want migrated into the wiki is listed there, with links to the temporary mirror site we've set up. If you see something there you would like to migrate into the wiki, "Edit" the Priority Content list and put your name beside title. If someone else has already signed up for it, try to contact that person to offer to help with it, so you can coordinate your efforts.

When you have signed up to help with migrating a piece of content, send a note to the devmo-general@ mailing list telling us who you are and which piece you are going to be working on. This just helps us keep track of what's going on.

Finally, go to the "stub page" that we've created for that content in the wiki, hit "Edit" and get started. When you're finished, or if you have any problems or questions, just send a note to the mailing list.

How to Help: Contributing new content

Contributing new content to the DevMo 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 DevMo 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 DevMo 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 decide where it would best fit within the existing wiki, add a link that points to the new page, then click on that link to create and edit your content.

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

1) Go to the JavaScript page, scroll down to the Tutorials section, and click "Edit" beside that section name.

2) I'd then add my article title to the list in that section 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 the JavaScript 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.

After adding your new content, it's usually a good idea to send a note to the DevMo:Mailing Lists. 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.

How to Help: 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 Help:Wiki Markup Reference you can reference. Once you're finished making changes, simply "Save" the page to commit those changes to the site.


How to Help: 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:Mailing Lists.

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.

Revision Source

<h3 name="Sign_up_to_the_DevMo-General_Mailing_List"> Sign up to the DevMo-General Mailing List </h3>
<p>Before you get started, it's recommended that you sign up to the <a href="en/DevMo/Mailing_Lists">devmo-general mailing list</a>.  All project questions, communication, and coordination are handled through the list, so it's fairly essential that all DevMo contributors are signed up there.
</p>
<h3 name="How_to_Help:_Migrating_DevEdge_content_to_the_DevMo_Wiki"> How to Help: Migrating DevEdge content to the DevMo Wiki </h3>
<p>First, read the <a href="Help:en/Wiki_Markup_Reference">DevMo 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="Help:en/Page_Naming_Guide">DevMo 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="en/DevEdge/Priority_Content">DevEdge:Priority Content</a> list.  The priority DevEdge content we want migrated into the wiki is listed there, with links to the temporary mirror site we've set up.  If you see something there you would like to migrate into the wiki, "Edit" the Priority Content list and put your name beside title.  If someone else has already signed up for it, try to contact that person to offer to help with it, so you can coordinate your efforts.
</p><p>When you have signed up to help with migrating a piece of content, send a note to the devmo-general@ mailing list telling us who you are and which piece you are going to be working on.  This just helps us keep track of what's going on.
</p><p>Finally, go to the "stub page" that we've created for that content in the wiki, hit "Edit" and get started.  When you're finished, or if you have any problems or questions, just send a note to the mailing list.
</p>
<h3 name="How_to_Help:_Contributing_new_content"> How to Help: Contributing new content </h3>
<p>Contributing new content to the DevMo 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="Help:en/Wiki_Markup_Reference">DevMo 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="Help:en/Page_Naming_Guide">DevMo 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 decide where it would best fit within the existing wiki, add a link that points to the new page, then click on that link to create and edit your content.  
</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 the <a href="en/JavaScript">JavaScript</a> page, scroll down to the <a href="en/JavaScript#Tutorials">Tutorials</a> section, and click "Edit" beside that section name.
</p><p>2) I'd then add my article title to the list in that section 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 the <a href="en/JavaScript">JavaScript</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>After adding your new content, it's usually a good idea to send a note to the <a href="en/DevMo/Mailing_Lists">DevMo:Mailing Lists</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>
<h3 name="How_to_Help:_Doing_technical_reviews"> How to Help: Doing technical reviews </h3>
<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="Help:en/Wiki_Markup_Reference">Help: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><br>
</p>
<h3 name="How_to_Help:_Doing_editorial_reviews"> How to Help: Doing editorial reviews </h3>
<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="en/DevMo/Mailing_Lists">DevMo:Mailing Lists</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>
Revert to this revision