Compare Revisions

Getting started

Change Revisions

Revision 49229:

Revision 49229 by Sheppy on

Revision 49230:

Revision 49230 by trevorh on

Getting started
Getting started
"MDC Project"
"MDC Project"

Revision 49229
Revision 49230
n10    <p>n
11      Helping with the MDC is as easy as using your browser. If y
>ou have ever filled in a web form or used a text area to write a  
>weblog post, you have all the browser skills you need to get star 
12    </p>
13    <h2>10    <h3>
n15    </h2>n12    </h3>
16    <p>
17      <strong>You are encouraged to help write, edit, review, and
> translate any documentation you find within these wikis.</strong 
>> Please do so in the spirit of cooperative improvement, and don' 
>t ever be disappointed if someone else corrects or improves upon  
>your contributions. We're all here to try to make Mozilla documen 
>tation much better (save for a few nasty spammers), so cooperatio 
>n and helping one another is always encouraged. 
18    </p>13    <p>
14      Helping with the MDN is as easy as using your browser. If y
 >ou have ever filled in a web form or used a text area to write a 
 >weblog post, you have all the browser skills you need to get star
15    </p>
16    <p>
17      <strong>You are encouraged to help write, edit, review, and
 > translate any documentation you find within these wikis.</strong
 >> Please do so in the spirit of cooperative improvement, and do n
 >ot be disappointed if someone else corrects or improves upon your
 > contributions. We are all here to try to make Mozilla documentat
 >ion much better (save for a few nasty spammers), so cooperation a
 >nd helping one another is always encouraged.
18    </p>
19    <h2>19    <h3>
20      Working with the site and community
21    </h3>
22    <p>
23      The documentation community is a group, largely comprised o
 >f volunteers, with the goal of providing useful documentation to 
 >users of Mozilla products and the web in general. We are always h
 >appy to help new writers and editors get involved and encourage e
 >veryone to participate in helping to make this documentation the 
 >best it can be.
24    </p>
25    <p>
26      We are all aware that joining a new group can be difficult 
 >so here is a short list that may help you.
27    </p>
28    <ul>
29      <li>Content is more important than style, grammar and even 
30      </li>
31      <li>It is fine to make mistakes! You can simply edit the pa
 >ge again to fix it. In the worst case every change can be quickly
 > and easily reversed, you can even do this yourself.
32      </li>
33      <li>No-one is going to be upset if you make a change to the
 > page they created. Everyone in the documentation community has t
 >he same goal, the best documentation possible.
34      </li>
35      <li>Do not be upset if someone edits the same page you did 
 >shortly afterwards. Most likely it is because your edit showed up
 > in the <a class="internal" href="/Special:Recentchanges" title="
 >Special:Recentchanges">Recent changes</a> list and someone review
 >ing this list realized there was something they could contribute.
36      </li>
37      <li>Sometimes your changes may be completely reversed. This
 > is a very rare occurrence, and may be a good opportunity to intr
 >oduce yourself to another member of the community.
38      </li>
39      <li>There are people in many different time zones participa
 >ting in documentation, so if you do not get a reply immediately f
 >rom your email, or on IRC please be patient.
40      </li>
41      <li>Mozilla employs a small friendly staff to manage the do
 >cumentation process. They review all the changes made and will fi
 >x any style or wording issues.
42      </li>
43    </ul>
44    <h3>
n21    </h2>n
22    <p>
23      Here's a short guide for creating and editing pages in the 
>MDC wikis. You're welcome to practice your wiki skills in the <a  
>href="/En/SandboxMove/Sandbox" title="En/SandboxMove/Sandbox">San 
24    </p>
25    <h3>46    </h3>
47    <p>
48      Here is a short guide for creating and editing pages in the
 > MDN wikis. You are welcome to practice your wiki skills in the <
 >a href="/En/Sandbox" title="En/Sandbox">Sandbox</a>.
49    </p>
50    <h4>
n27    </h3>n52    </h4>
n29      To edit a page, you will first have to create an account onn54      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" t> the wiki. Do this by going to the <a href="/Special:Userlogin" t
>itle="Log in">User login</a> page and then filling out and submit>itle="Log in">User login</a> page and then filling out and submit
>ting the form. Once you've created an account, you will automatic>ting the form. Once you have created an account, you will automat
>ally be logged in and able to edit.>ically be logged in and able to edit.
30    </p>
31    <p>55    </p>
56    <p>
32      At the top of every page, you will now see an "Edit page" l57      At the top of every page, you will now see an "Edit page" l
>ink. Clicking this link brings you to the editing form for the se>ink. Clicking this link brings you to the editing form for the se
>lected page, where you can make and preview whatever changes you >lected page, where you can make and preview whatever changes you 
>wish to make, then save them into the wiki. Once you save your ed>wish to make, then save them into the wiki. Once you save your ed
>its, you'll be able to see them immediately on the page.>its, you will be able to see them immediately on the page.
n37    <h3>n62    <h4>
n39    </h3>n64    </h4>
n44      If you don't know where to put a new article, <strong>don'tn69      If you do not know where to put a new article, <strong>do n
> worry about it</strong>! Put it anywhere, and we'll find it and >ot worry about it!</strong> Put it anywhere, and we will find it 
>move it to where it belongs, or merge it into existing content if>and move it to where it belongs, or merge it into existing conten
> that makes the most sense. You also don't need to worry about ma>t if that makes the most sense. You also do not need to worry abo
>king it perfect. We have happy helper gnomes that will help make >ut making it perfect. We have happy helper gnomes that will help 
>your content clean and luscious.>make your content clean and luscious.
45    </p>
46    <p>70    </p>
47      To get to your user page, click on your user name in the to
>p blue bar of the wiki. If you haven't added anything to your use 
>r page, you'll be brought immediately into the editing form for t 
>he page where you can add whatever content you like. 
48    </p>71    <p>
72      To get to your user page, click on your user name in the to
 >p blue bar of the wiki. If you have not added anything to your us
 >er page, you will be brought immediately into the editing form fo
 >r the page where you can add whatever content you like.
49    <p>73    </p>
50      There are two ways to create a link to a new page.&nbsp; Yo
>u can click the Insert/Edit Link button in the editor's toolbar,  
>then type the name of the page when prompted to do so.&nbsp; You  
>can also simply write the title for the page enclosed with double 
> square brackets, like this: <code><span class="nowiki">[[en/Here 
> is an example]]</span></code>. When saved, that will be turned i 
>nto a link, like this: <a href="/en/Here_is_an_example" title="en 
>/Here_is_an_example">Here is an example</a>. Note that you need t 
>o include the language code. 
51    </p>74    <p>
75      There are two ways to create a link to a new page. You can 
 >click the Insert/Edit Link button in the editor's toolbar, then t
 >ype the name of the page when prompted to do so. You can also sim
 >ply write the title for the page enclosed with double square brac
 >kets, like this: <code><span class="nowiki">[[en/Here is an examp
 >le]]</span></code>. When saved, that will be turned into a link, 
 >like this: <a href="/en/Here_is_an_example" title="en/Here_is_an_
 >example">Here is an example</a>. Note that you need to include th
 >e language code.
52    <p>76    </p>
77    <p>
53      If the page doesn't already exist, the link will be in red.78      If the page does not already exist, the link will be in red
> If it <em>does</em> already exist, the link will be in blue. Sho>. If it <em>does</em> already exist, the link will be in blue. Sh
>uld you want to create a new page but the page title you want is >ould you want to create a new page but the page title you want is
>already taken, check first to see if it makes more sense to help > already taken, check first to see if it makes more sense to help
>edit and improve the page that's already there. Otherwise, think > edit and improve the page that is already there. Otherwise, thin
>of a different title for your new page and create a link for it.>k of a different title for your new page and create a link for it
54    </p>
55    <p>79    </p>
80    <p>
56      When you want to add content to your new page, simply click81      When you want to add content to your new page, simply click
> on the red link you just created and start writing. Remember to > on the red link you just created and start writing. Remember to 
>use the "Save" button in the editor's toolbar to save your work (>use the "Save" button in the editor's toolbar to save your work (
>be sure to save often if you're working on a long piece).>be sure to save often if you are working on a long piece).
n64    <h3>n89    <h4>
n66    </h3>n91    </h4>
n68      MindTouch Deki, the software the Mozilla Developer Center un93      MindTouch Deki, the software the Mozilla Developer Network 
>ses, uses XHTML as its markup language for the documentation.&nbs>uses, uses XHTML as its markup language for the documentation. If
>p; If you wish to see or edit the XHTML content, you can do so by> you wish to see or edit the XHTML content, you can do so by clic
> clicking the "Source" button in the toolbar while in edit mode.&>king the "Source" button in the toolbar while in edit mode. Click
>nbsp; Click it again to return to the WYSIWYG editor.&nbsp;> it again to return to the WYSIWYG editor.
n70    <h2>n95    <h3>
n72    </h2>n97    </h3>
n74      Here's a slightly longer introduction to the MDC for writern99      Here is a slightly longer introduction to the MDN for write
>s, editors, and reviewers.>rs, editors, and reviewers.
n76    <h3>n101    <h4>
n78    </h3>n103    </h4>
n80      The MDC is always interested in new content, so you're encon105      The MDN is always interested in new content, so you are enc
>uraged to write new articles on whatever <a href="/Special:Tags?t>ouraged to write new articles on whatever <a href="/Special:Tags?
>ag=All_Categories&amp;language=en" title="Special:Tags?tag=All_Ca>tag=All_Categories&amp;language=en" title="Special:Tags?tag=All_C
>tegories&amp;language=en">topics</a> we currently cover in the wi>ategories&amp;language=en">topics</a> we currently cover in the w
>ki. New content can be as simple as a one page tip or as complex >iki. New content can be as simple as a one page tip or as complex
>as a book-length programming guide or reference. The amount of ne> as a book-length programming guide or reference. The amount of n
>w content you contribute is entirely up to you.>ew content you contribute is entirely up to you.
n86      If you're going to undertake a large project, I suggest youn111      If you are going to undertake a large project, I suggest yo
> join the <a href="/Project:en/Getting_started#Joining_the_MDC_co>u join the <a href="/Project:en/Getting_started#Joining_the_MDN_c
>mmunity" title="Project:en/Getting_started#Joining_the_MDC_commun>ommunity" title="Project:en/Getting_started#Joining_the_MDN_commu
>ity">MDC community</a> and discuss it there first in case someone>nity">MDN community</a> and discuss it there first in case someon
> else is planning to start (or has already started) a similar pro>e else is planning to start (or has already started) a similar pr
n91    <h3>n116    <h4>
n93    </h3>n118    </h4>
n98      You don't need special privileges to edit the wiki; simply n123      You do not need special privileges to edit the wiki; simply
><a class="external" href="/Special:Userlogin" title="https://deve> <a class="external" href="/Special:Userlogin" title="https://dev
>true">sign up for a free MDC&nbsp;account</a> and dive right in!>=true">sign up for a free MDaccount</a> and dive right in!
n100    <h3>n125    <h4>
n102    </h3>n127    </h4>
103    <p>
104      Technical improvements and review are always welcome. If yo
>u'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 controv 
>ersial change, make a note in the "talk" page (accessed by clicki 
>ng the "Talk page" option in the "More options" menu) and leave a 
> note that outlines your reasons for the change. 
105    </p>128    <p>
129      Technical improvements and review are always welcome. If yo
 >u are 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 contro
 >versial change, make a note in the "talk" page (accessed by click
 >ing the "Talk page" option in the "More options" menu) and leave 
 >a note that outlines your reasons for the change.
130    </p>
106    <h3>131    <h4>
n108    </h3>n133    </h4>
n110      We have a <a href="/Project:en/Writer's_guide" title="Projen135      We have a <a href="/Project:en/Writer's_guide" title="Proje
>ct:en/Writer's_guide">writer's guide</a> outlining preferred writ>ct:en/Writer's_guide">writer's guide</a> outlining preferred writ
>ing style practices for the MDC wiki. If you have questions about>ing style practices for the MDN wiki. If you have questions about
> usage and style that aren't covered there, I recommend referring> usage and style that are not covered there, I recommend referrin
> to the <a class="external" href=">g to the <a class="external" href="
>ch/StyleGuide/">Economist style guide</a> or, failing that, the <>rch/StyleGuide/">Economist style guide</a> or, failing that, the 
>a class="external" href="><a class="external" href="
>036/">Chicago Manual of Style</a>.>4036/">Chicago Manual of Style</a>.
111    </p>
112    <p>136    </p>
113      We will be expanding the guide over time, so if you have sp137    <p>
>ecific questions that aren't covered by the <a href="/Project:en/ 
>Writer's_guide" title="Project:en/Writer's_guide">writer's guide< 
>/a>, please send them to the <a href="/Project:en/Community" titl 
>e="Project:en/Community">MDC mailing list</a> or <a href="/User:S 
>heppy" title="User:Sheppy">developer documentation lead</a>. 
138      We will be expanding the guide over time, so if you have sp
 >ecific questions that are not covered by the <a href="/Project:en
 >/Writer's_guide" title="Project:en/Writer's_guide">writer's guide
 ></a>, please send them to the <a href="/Project:en/Community" tit
 >le="Project:en/Community">MDN mailing list</a> or <a href="/User:
 >Sheppy" title="User:Sheppy">developer documentation lead</a>.
n119      One longer ongoing subproject at the MDC is to migrate all n144      One longer ongoing subproject at the MDN is to migrate all 
>currently existing developer documentation from the <a class="ext>currently existing developer documentation from the <a class="ext
>ernal" href=""></a> web site int>ernal" href=""></a> web site int
>o the MDC wiki. The procedure is fairly simple:>o the MDN wiki. The procedure is fairly simple:
n126      <li>Create those pages and migrate the content, marking it n151      <li>Create those pages and migrate the content, marking it 
>up as best you can using the <a href="/Project:En/MDC_style_guide>up as best you can using the <a href="/Project:En/MDN_style_guide
>" title="Project:en/Wiki_Markup_Reference">wiki markup reference<>" title="Project:en/Wiki_Markup_Reference">wiki markup reference<
>/a> as a guide.>/a> as a guide.
n134      If you're keen on doing a comprehensive job on this, you'lln159      If you are keen on doing a comprehensive job on this, you w
> also:>ill also:
n137      <li>Use <a href="Special:Search">our search system</a> to sn162      <li>Use <a href="/Special:Search" title="Search">our search
>earch for any links to the original document in the wiki, then ch> system</a> to search for any links to the original document in t
>ange those links so they point at the new wiki page.>he wiki, then change those links so they point at the new wiki pa
n142    <h2>n167    <h3>
143      Localizing the MDC168      Localizing the MDN
144    </h2>169    </h3>
n146      If you're interested in helping translate the documentationn171      If you are interested in helping translate the documentatio
> in any of the MDC wikis to another language, simply visit the re>n in any of the MDN wikis to another language, simply visit the r
>levant language's wiki and create or edit pages.>elevant language's wiki and create or edit pages.
n148    <h3>n173    <h4>
n150    </h3>n175    </h4>
151    <p>
152      Currently the MDC has wikis for the following languages: <a
> class=" external" href="">Català< 
>/a>,<a class=" external" href="">Č 
>eština</a>, <a class=" external" href="http://developer.mozilla.o 
>rg/cn">中文(简体)</a>, <a class=" external" href=" 
>">Deutsch</a>, <a class=" external" href="http://deve 
>">English</a>, <a class=" external" href="htt 
>p://">Español</a>, <a class=" external" h 
>ref="">Français</a>, <a class=" ex 
>ternal" href="">Italiano</a>, <a c 
>lass=" external" href="">日本語</a>,  
><a href="/hu" title="hu">Magyar</a>, <a class=" external" href="h 
>ttp://">Nederlands</a>, <a class=" extern 
>al" href="">Polski</a>, <a class=" 
> external" href="">Português</a>,  
><a class=" external" href="">한국어</ 
>a>, <a class=" external" href=" 
>">中文(正體)</a>, <a class=" external" href="http://developer.mozilla 
>.org/ru">Русский</a>, <a class=" external" href="http://developer 
>">Suomi</a>, <a class=" external" href="http://dev 
>">Türkçe</a>, <a class=" external" href="htt 
153    </p>176    <p>
177      Currently the MDN has wikis for the following languages: <a
 > class=" external" href="">Català<
 >/a>,<a class=" external" href="">Č
 >eština</a>, <a class=" external" href="http://developer.mozilla.o
 >rg/cn">中文(简体)</a>, <a class=" external" href="
 >">Deutsch</a>, <a class=" external" href="http://deve
 >">English</a>, <a class=" external" href="htt
 >p://">Español</a>, <a class=" external" h
 >ref="">Français</a>, <a class=" ex
 >ternal" href="">Italiano</a>, <a c
 >lass=" external" href="">日本語</a>, 
 ><a href="/hu" title="hu">Magyar</a>, <a class=" external" href="h
 >ttp://">Nederlands</a>, <a class=" extern
 >al" href="">Polski</a>, <a class="
 > external" href="">Português</a>, 
 ><a class=" external" href="">한국어</
 >a>, <a class=" external" href="
 >">中文(正體)</a>, <a class=" external" href="http://developer.mozilla
 >.org/ru">Русский</a>, <a class=" external" href="http://developer
 >">Suomi</a>, <a class=" external" href="http://dev
 >">Türkçe</a>, <a class=" external" href="htt
178    </p>
154    <h3>179    <h4>
n156    </h3>n181    </h4>
n158      If you would like to start a new localization project for an183      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 > language we do not currently have a wiki for, please read the <a
>href="/Project:en/Localization_Projects" title="Project:en/Locali> href="/Project:en/Localization_Projects" title="Project:en/Local
>zation_Projects">localization projects</a> page and follow the in>ization_Projects">localization projects</a> page and follow the i
>structions there.>nstructions there.
n167      Should no resolution be possible, please bring it to the atn192      Should no resolution be possible, please bring it to the at
>tention of either (ideally) the <a href="/Project:en/Community" t>tention of either (ideally) the <a href="/Project:en/Community" t
>itle="Project:en/Community">MDC mailing list</a> or (as a last re>itle="Project:en/Community">MDN mailing list</a> or (as a last re
>sort) the <a href="/User:Sheppy" title="User:Sheppy">developer do>sort) the <a href="/User:Sheppy" title="User:Sheppy">developer do
>cumentation lead</a>. Other technical experts, writers, and edito>cumentation lead</a>. Other technical experts, writers, and edito
>rs will be consulted as required, and their expertise will be use>rs will be consulted as required, and their expertise will be use
>d to resolve the problem.>d to resolve the problem.
n182      Joining the MDC communityn207      Joining the MDN community
183    </h2>
184    <p>
185      The Mozilla Developer Center is largely the handiwork of a 
>group of volunteers, and we're always happy to help new writers a 
>nd editors get involved. 
186    </p>208    </h2>
n190    <ul>n212    <p>
191      <li>View MDC forums...213      View MDN forums...
192      </li>
193    </ul>214    </p>
t207      The MDC and developer documentation is overseen by <a classt228      The MDN and developer documentation is overseen by <a class
>="link-mailto" href="">Eric Shepherd<>="link-mailto" href="">Eric Shepherd<

Back to History