Getting started

  • Revision slug: Project:Getting_started
  • Revision title: Getting started
  • Revision id: 49116
  • Created:
  • Creator: Dria
  • Is current revision? No
  • Comment

Revision Content

Just getting started on this...will be revising and expanding over the next few days. -- dria 20:37, 13 March 2006 (PST)

Introduction

Helping with the MDC is as easy as using your browser. If you have ever filled in a web form or used a textarea to write a weblog post, you have all the browser skills you need to get started.

You are encouraged to help write, edit, review, and translate any documentation you find within these wikis. Please do so, however, in the spirit of co-operative improvement, and don't be disappointed or upset if someone later corrects or improves upon your contributions. We're all here to try to make Mozilla documentation better (save for a few nasty spammers), so co-operation, working together, and helping each other is always encouraged.


The basics

Here's a short guide to editing and creating pages in the MDC wikis.

Editing pages

To edit a page you will first have to create an account on the wiki. Do this by going to the User login page and then filling out and submitting the form. Once you have created an account you will be automatically logged in and able to edit.

In the right-hand column of every page you will now see an "Edit" link. Clicking this link will bring you to the editing form for the page, where you can make whatever changes you like, preview those changes, then save them into the wiki. Once you save your edits, you'll be able to see them immediately on the page.

Starting a new page

The easiest way to start a new page is to create a link for it on your user page, then use that link to enter into the "Edit" mode for the page.

To get to your user page, click on your user name in the top blue bar of the wiki. If you haven't added anything to your user page, you'll be brought immediately into the editing form for the page where you can add whatever content you like.

Creating a link to the page you want to add is as simple as writing the title for the page enclosed with double square brackets, like this: [[Here is an example]]. When saved, that will be turned into a link, like this: Here is an example.

If the page doesn't already exist, the link will be in red. If it does already exist, the link will be in blue. Should you want to create a new page but the page title you want is already taken, check first to see if you might be better to help edit and improve the page that's already there. Otherwise, think of a different title for your new page and create a link for it.

When you want to add content to your new page, simply click on the red link you just created and start writing. Remember to use the "Save page" button at the bottom of the editing form to save your work (often, if you're working on a long piece).

Page naming guide

For more information about creating and naming new pages, see our page naming guide.

Wiki markup

If you click "Edit" in the right-hand column now, you'll see that the text of this page contains some special characters, for example the "==" marks around headings and the "[{{mediawiki.external(' ]')}}" brackets around links. This is a very simple form of textual markup that is unique to wiki systems. The power of this markup system is that it's very easy to learn, and tends to be pretty forgiving if you make a mistake.

Wiki markup reference

We have a full wiki markup reference you can use to learn the markup language as you're editing the wiki.

Writing, editing, and reviewing

Here's a slightly longer introduction the MDC for writers, editors, and reviewers.

Writers

The MDC is always interested in new content, so you're encouraged to write new articles on whatever topics we currently cover in the wiki. New content can be as simple as a one page "tip" or as complex as a full-blown book-length programming guide or reference. The amount of new content you contribute is entirely up to you.

If you're going to undertake a large project, I suggest you join the MDC community and discuss it there first, just in case someone else is planning to start (or has already started) a similar project.

I suggest referring to our writer's guide if you have questions about style or usage policies within the wiki.

Editors

Copy editing is always welcome in this wiki, particularly to improve or correct writing style, grammar, or spelling. Please see our writer's guide for more information.

Reviewers

Technical improvements and review are always welcome here, so if you're reading through a page and spot a technical error (be it in code or text), please feel free to correct it. If it is a possibly controversial change, make a note in the "talk" page (accessed by clicking the "Discuss" link in the right hand column) and leave a note outlining your reasons for the change there.

Writer's guide

We have a rudimentary writer's guide started for MDC writing work. If you have questions about usage and style that aren't covered there, I recommend referring to the Economist style guide or, failing that, the Chicago Manual of Style.

We will be expanding the guide over time, so if you do have specific questions that aren't covered by the writer's guide, please send them to the MDC mailing list or project lead (see below) so we know what should be added.

Localizing the MDC

If you're interested in helping translate the documentation in any of the MDC wikis to another language, you can do so simply by visiting the relevant language's wiki and editing/creating pages.

Current localizations

Currently the MDC has wikis for the following languages:

Starting a new localization

If you would like to start a new localization project for a language we don't currently have a wiki for, please read the localization projects page and follow the instructions there.

Resolving "edit wars" or other conflicts

If for whatever reason you end up in an "edit war" on a page, where two or more people are continually and repeatedly making and reverting changes, please first try to resolve the conflict with the people involved.

Should no resolution be possible, please bring it to the attention of either the (ideally) MDC mailing list or (as a last resort) MDC project lead. Other technical experts, writers, and editors will be consulted as required, and their expertise will be used to resolve the problem.

Joining the MDC community

The Mozilla Developer Center is largely the handiwork of a group of volunteers, and we're always happy to help new writers and editors learn and use the wiki.

MDC mailing list / newsgroup

  • View MDC forums...

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

MDC IRC channel

We also hang out on the irc.mozilla.org server in the #devmo channel: #devmo on irc.mozilla.org.

MDC project lead

The MDC is overseen by Deb Richardson.

Revision Source

<p>
</p>
<div class="note">
<p>Just getting started on this...will be revising and expanding over the next few days. -- <a href="User:Dria">dria</a> 20:37, 13 March 2006 (PST)
</p>
</div>
<h3 name="Introduction"> Introduction </h3>
<p>Helping with the MDC is as easy as using your browser.  If you have ever filled in a web form or used a textarea to write a weblog post, you have all the browser skills you need to get started.
</p><p><b>You are encouraged to help write, edit, review, and translate any documentation you find within these wikis.</b>  Please do so, however, in the spirit of co-operative improvement, and don't be disappointed or upset if someone later corrects or improves upon your contributions.  We're all here to try to make Mozilla documentation better (save for a few nasty spammers), so co-operation, working together, and helping each other is always encouraged.
</p><p><br>
</p>
<h3 name="The_basics"> The basics </h3>
<p>Here's a short guide to editing and creating pages in the MDC wikis.
</p>
<h4 name="Editing_pages"> Editing pages </h4>
<p>To edit a page you will first have to create an account on the wiki.  Do this by going to the <a href="Special:Userlogin">User login</a> page and then filling out and submitting the form. Once you have created an account you will be automatically logged in and able to edit.
</p><p>In the right-hand column of every page you will now see an "Edit" link.  Clicking this link will bring you to the editing form for the page, where you can make whatever changes you like, preview those changes, then save them into the wiki.  Once you save your edits, you'll be able to see them immediately on the page.
</p>
<h4 name="Starting_a_new_page"> Starting a new page </h4>
<p>The easiest way to start a new page is to create a link for it on your user page, then use that link to enter into the "Edit" mode for the page.  
</p><p>To get to your user page, click on your user name in the top blue bar of the wiki.  If you haven't added anything to your user page, you'll be brought immediately into the editing form for the page where you can add whatever content you like. 
</p><p>Creating a link to the page you want to add is as simple as writing the title for the page enclosed with double square brackets, like this: <code><span class="plain">[[Here is an example]]</span></code>.  When saved, that will be turned into a link, like this: <a href="en/Here_is_an_example">Here is an example</a>.
</p><p>If the page doesn't already exist, the link will be in red.  If it <i>does</i> already exist, the link will be in blue.  Should you want to create a new page but the page title you want is already taken, check first to see if you might be better to help edit and improve the page that's already there.  Otherwise, think of a different title for your new page and create a link for it.
</p><p>When you want to add content to your new page, simply click on the red link you just created and start writing.  Remember to use the "Save page" button at the bottom of the editing form to save your work (often, if you're working on a long piece).
</p>
<h5 name="Page_naming_guide"> Page naming guide </h5>
<p>For more information about creating and naming new pages, see our <a href="Project:en/Page_Naming_Guide">page naming guide</a>.
</p>
<h4 name="Wiki_markup"> Wiki markup </h4>
<p>If you click "Edit" in the right-hand column now, you'll see that the text of this page contains some special characters, for example the "==" marks around headings and the "[{{mediawiki.external(' ]')}}" brackets around links.  This is a very simple form of textual markup that is unique to wiki systems.  The power of this markup system is that it's very easy to learn, and tends to be pretty forgiving if you make a mistake.
</p>
<h5 name="Wiki_markup_reference"> Wiki markup reference </h5>
<p>We have a full <a href="Project:en/Wiki_Markup_Reference">wiki markup reference</a> you can use to learn the markup language as you're editing the wiki.
</p>
<h3 name="Writing.2C_editing.2C_and_reviewing"> Writing, editing, and reviewing </h3>
<p>Here's a slightly longer introduction the MDC for writers, editors, and reviewers.
</p>
<h4 name="Writers"> Writers </h4>
<p>The MDC is always interested in new content, so you're encouraged to write new articles on whatever topics we currently cover in the wiki.  New content can be as simple as a one page "tip" or as complex as a full-blown book-length programming guide or reference.  The amount of new content you contribute is entirely up to you.
</p><p>If you're going to undertake a large project, I suggest you join the <a href="Project:en/Getting_Started#Joining_the_MDC_community">MDC community</a> and discuss it there first, just in case someone else is planning to start (or has already started) a similar project.
</p><p>I suggest referring to our <a href="Project:en/Writer's_guide">writer's guide</a> if you have questions about style or usage policies within the wiki.
</p>
<h4 name="Editors"> Editors </h4>
<p>Copy editing is always welcome in this wiki, particularly to improve or correct  writing style, grammar, or spelling.  Please see our <a href="Project:en/Writer's_guide">writer's guide</a> for more information.
</p>
<h4 name="Reviewers"> Reviewers </h4>
<p>Technical improvements and review are always welcome here, so if you're reading through a page and spot a technical error (be it in code or text), please feel free to correct it.  If it is a possibly controversial change, make a note in the "talk" page (accessed by clicking the "Discuss" link in the right hand column) and leave a note outlining your reasons for the change there.
</p>
<h4 name="Writer.27s_guide"> Writer's guide </h4>
<p>We have a rudimentary <a href="Project:en/Writer's_guide">writer's guide</a> started for MDC writing work.  If you have questions about usage and style that aren't covered there, I recommend referring to the <a class="external" href="http://www.economist.com/research/StyleGuide/">Economist style guide</a> or, failing that, the <a class="external" href="http://www.amazon.com/gp/product/0226104036/">Chicago Manual of Style</a>.
</p><p>We will be expanding the guide over time, so if you do have specific questions that aren't covered by the <a href="Project:en/Writer's_guide">writer's guide</a>, please send them to the MDC mailing list or project lead (<i>see below</i>) so we know what should be added.
</p>
<h3 name="Localizing_the_MDC"> Localizing the MDC </h3>
<p>If you're interested in helping translate the documentation in any of the MDC wikis to another language, you can do so simply by visiting the relevant language's wiki and editing/creating pages.
</p>
<h4 name="Current_localizations"> Current localizations </h4>
<p>Currently the MDC has wikis for the following languages:
</p>
<ul><li> <a class="external" href="http://developer.mozilla.org/ca/docs/">Català</a>
</li><li> <a class="external" href="http://developer.mozilla.org/cn/docs/">中文(简体)</a>
</li><li> <a class="external" href="http://developer.mozilla.org/de/docs/">Deutsch</a>
</li><li> <a class="external" href="http://developer.mozilla.org/en/docs/">English</a>
</li><li> <a class="external" href="http://developer.mozilla.org/fr/docs/">Français</a>
</li><li> <a class="external" href="http://developer.mozilla.org/it/docs/">Italiano</a>
</li><li> <a class="external" href="http://developer.mozilla.org/ja/docs/">日本語</a>
</li><li> <a class="external" href="http://developer.mozilla.org/nl/docs/">Nederlands</a>
</li><li> <a class="external" href="http://developer.mozilla.org/pl/docs/">Polski</a>
</li><li> <a class="external" href="http://developer.mozilla.org/pt/docs/">Português</a>
</li><li> <a class="external" href="http://developer.mozilla.org/es/docs/">Español</a>
</li><li> <a class="external" href="http://developer.mozilla.org/ko/docs/">한국어</a>
</li></ul>
<h4 name="Starting_a_new_localization"> Starting a new localization </h4>
<p>If you would like to start a new localization project for a language we don't currently have a wiki for, please read the <a href="Project:en/Localization_Projects">localization projects</a> page and follow the instructions there.
</p>
<h3 name="Resolving_.22edit_wars.22_or_other_conflicts"> Resolving "edit wars" or other conflicts </h3>
<p>If for whatever reason you end up in an "edit war" on a page, where two or more people are continually and repeatedly making and reverting changes, please first try to resolve the conflict with the people involved.  
</p><p>Should no resolution be possible, please bring it to the attention of either the (ideally) <a href="Project:en/Community">MDC mailing list</a> or (as a last resort) <a href="User:Dria">MDC project lead</a>.  Other technical experts, writers, and editors will be consulted as required, and their expertise will be used to resolve the problem.
</p>
<h3 name="Joining_the_MDC_community"> Joining the MDC community </h3>
<p>The Mozilla Developer Center is largely the handiwork of a group of volunteers, and we're always happy to help new writers and editors learn and use the wiki.  
</p>
<h4 name="MDC_mailing_list_.2F_newsgroup"> MDC mailing list / newsgroup </h4>
<ul><li> View MDC forums...
</li></ul>
<p>{{template.DiscussionList("dev-mdc", "mozilla.dev.mdc")}}
</p>
<h4 name="MDC_IRC_channel"> MDC IRC channel </h4>
<p>We also hang out on the irc.mozilla.org server in the #devmo channel: <a class="external" href="irc://irc.mozilla.org/devmo">#devmo on irc.mozilla.org</a>.
</p>
<h4 name="MDC_project_lead"> MDC project lead </h4>
<p>The MDC is overseen by <a class="external" href="mailto:deb@mozilla.com">Deb Richardson</a>.
</p>
Revert to this revision