Compare Revisions

Getting started

Change Revisions

Revision 49214:

Revision 49214 by Sheppy on

Revision 49215:

Revision 49215 by temmy23 on

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

Revision 49214
Revision 49215
n8      {{ MDCProjectPagesTOC() }}n8      temmy23
t10    <p>t
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    <h3 name="Introduction">
14      Introduction
15    </h3>
16    <p>
17      <b>You are encouraged to help write, edit, review, and tran
>slate any documentation you find within these wikis.</b> Please d 
>o so in the spirit of cooperative improvement, and don't ever be  
>disappointed if someone else corrects or improves upon your contr 
>ibutions. We're all here to try to make Mozilla documentation muc 
>h better (save for a few nasty spammers), so cooperation and help 
>ing one another is always encouraged. 
18    </p>
19    <h3 name="The_basics">
20      The basics
21    </h3>
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  
24    </p>
25    <h4 name="Editing_pages">
26      Editing pages
27    </h4>
28    <p>
29      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 
>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 
>ally be logged in and able to edit. 
30    </p>
31    <p>
32      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 
>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 
>its, you'll be able to see them immediately on the page. 
33    </p>
34    <p>
35      You can also point at a subtitle on a page and click the ed
>it button that appears next to it to edit just that section. 
36    </p>
37    <h4 name="Starting_a_new_page">
38      Starting a new page
39    </h4>
40    <p>
41      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 the "Edit" mod 
>e for the page. 
42    </p>
43    <p>
44      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. 
45    </p>
46    <p>
47      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. 
48    </p>
49    <p>
50      If the page doesn't already exist, the link will be in red.
> If it <em>does</em> already exist, the link will be in blue. Sho 
>uld 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  
>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. 
51    </p>
52    <p>
53      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" button in the editor's toolbar to save your work ( 
>be sure to save often if you're working on a long piece). 
54    </p>
55    <h5 name="Page_naming_guide">
56      Page naming guide
57    </h5>
58    <p>
59      For more information about creating and naming new pages, s
>ee our <a href="/Project:en/Page_Naming_Guide" title="Project:en/ 
>Page_Naming_Guide">page naming guide</a>. 
60    </p>
61    <h4 name="Wiki_markup">
62      Wiki markup
63    </h4>
64    <p>
65      MindTouch Deki, the software the Mozilla Developer Center u
>ses, uses XHTML as its markup language for the documentation.&nbs 
>p; If you wish to see or edit the XHTML content, you can do so by 
> clicking the "Source" button in the toolbar while in edit mode.& 
>nbsp; Click it again to return to the WYSIWYG editor.&nbsp; You c 
>an only save changes from WYSIWYG mode.&nbsp; This is the case be 
>cause the editor intelligently corrects errors in your XHTML if a 
>ny are found when you switch back to that mode. 
66    </p>
67    <h3 name="Writing.2C_editing.2C_and_reviewing">
68      Writing, editing, and reviewing
69    </h3>
70    <p>
71      Here's a slightly longer introduction to the MDC for writer
>s, editors, and reviewers. 
72    </p>
73    <h4 name="Writers">
74      Writers
75    </h4>
76    <p>
77      The MDC is always interested in new content, so you're enco
>uraged to write new articles on whatever <a href="Special:Tags?ta 
>g=All_Categories&amp;language=en">topics</a> we currently cover i 
>n the wiki. New content can be as simple as a one page tip or as  
>complex as a book-length programming guide or reference. The amou 
>nt of new content you contribute is entirely up to you. 
78    </p>
79    <p>
80      Bugs in the Mozilla project's <a class="external" href="htt
>p://">Bugzilla database</a> that impact docum 
>entation should be tagged with the <code>dev-doc-needed</code> ke 
>yword. This is another great way to find items that may require d 
>ocumentation. Typically, only bugs for which changes have already 
> been checked into the source code should be written up. When the 
> required documentation changes have been made, the <code>dev-doc 
>-complete</code> keyword should be added to the bug. 
81    </p>
82    <p>
83      If you're going to undertake a large project, I suggest you
> join the <a href="Project:en/Getting_started#Joining_the_MDC_com 
>munity">MDC community</a> and discuss it there first in case some 
>one else is planning to start (or has already started) a similar  
84    </p>
85    <p>
86      Refer to our <a href="Project:en/Writer's_guide">writer's g
>uide</a> if you have questions about style or usage policies with 
>in the wiki. 
87    </p>
88    <h4 name="Editors">
89      Editors
90    </h4>
91    <p>
92      Copy editing is always welcomed 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> f 
>or more information. 
93    </p>
94    <h4 name="Reviewers">
95      Reviewers
96    </h4>
97    <p>
98      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. 
99    </p>
100    <h4 name="Writer.27s_guide">
101      Writer's guide
102    </h4>
103    <p>
104      We have a <a href="Project:en/Writer's_guide">writer's guid
>e</a> outlining preferred writing style practices for the MDC wik 
>i. If you have questions about usage and style that aren't covere 
>d there, I recommend referring to the <a class="external" href="h 
>ttp://">Economist style gui 
>de</a> or, failing that, the <a class="external" href="http://www 
>">Chicago Manual of Style</a>. 
105    </p>
106    <p>
107      We will be expanding the guide over time, so if you have sp
>ecific questions that aren't covered by the <a href="Project:en/W 
>riter's_guide">writer's guide</a>, please send them to the <a hre 
>f="Project:en/Community">MDC mailing list</a> or <a href="User:Sh 
>eppy">developer documentation lead</a>. 
108    </p>
109    <h3 name="Migrating_old_documentation">
110      Migrating old documentation
111    </h3>
112    <p>
113      One longer ongoing subproject at the MDC is to migrate all 
>currently existing developer documentation from the <a class="ext 
>ernal" href=""></a> web site int 
>o the MDC wiki. The procedure is fairly simple: 
114    </p>
115    <ol>
116      <li>Pick a document you would like to migrate from the <a h
>ref="/Project:en/Existing_Content" title="Project:en/Existing_Con 
>tent">existing content</a> list. 
117      </li>
118      <li>Refer to the <a href="/Project:en/Page_Naming_Guide" ti
>tle="Project:en/Page_Naming_Guide">page naming guide</a> and deci 
>de what the page or pages for that document should be called in t 
>he wiki. 
119      </li>
120      <li>Create those pages and migrate the content, marking it 
>up as best you can using the <a href="/Project:en/Wiki_Markup_Ref 
>erence" title="Project:en/Wiki_Markup_Reference">wiki markup refe 
>rence</a> as a guide. 
121      </li>
122      <li>Delete the item from the <a href="/Project:en/Existing_
>Content" title="Project:en/Existing_Content">existing content</a> 
> list. 
123      </li>
124      <li>Add the item to the <a href="/Project:en/Needs_Redirect
>" title="Project:en/Needs_Redirect">needs redirect</a> list. 
125      </li>
126    </ol>
127    <p>
128      If you're keen on doing a comprehensive job on this, you'll
> also: 
129    </p>
130    <ol>
131      <li>Use <a class="external" href="http://search.developer.m
>">our search system</a> to search for any links to the  
>original document in the wiki, then change those links so they po 
>int at the new wiki page. 
132      </li>
133      <li>Check for <a href="/Project:en/External_Redirects" titl
>e="Project:en/External_Redirects">external redirects</a> to the o 
>riginal document, and flag those redirects for deletion by adding 
> the "Junk" tag to them. 
134      </li>
135    </ol>
136    <h3 name="Localizing_the_MDC">
137      Localizing the MDC
138    </h3>
139    <p>
140      If you're interested in helping translate the documentation
> in any of the MDC wikis to another language, simply visit the re 
>levant language's wiki and create or edit pages. 
141    </p>
142    <h4 name="Existing_localization_projects">
143      Existing localization projects
144    </h4>
145    <p>
146      Currently the MDC has wikis for the following languages: <a
> class="external" href="">Ca 
>talà</a>, <a class="external" href=" 
>cn/docs/">中文(简体)</a>, <a class="external" href="http://developer. 
>">Deutsch</a>, <a class="external" href="http 
>://">English</a>, <a class="externa 
>l" href="">Français</a>, <a  
>class="external" href="">Ita 
>liano</a>, <a class="external" href=" 
>/ja/docs/">日本語</a>, <a class="external" href=" 
>">Nederlands</a>, <a class="external" href="htt 
>p://">Polski</a>, <a class="externa 
>l" href="">Português</a>, <a 
> class="external" href="">Es 
>pañol</a>, <a class="external" href=" 
>/ko/docs/">한국어</a>, <a class="external" href=" 
>">中文(正體)</a>, <a class="external" href="http 
>://">Русский</a>, <a class="externa 
>l" href="">Hindi</a>. 
147    </p>
148    <h4 name="How_to_start_a_new_localization_project">
149      How to start a new localization project
150    </h4>
151    <p>
152      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. 
153    </p>
154    <h3 name="Resolving_.22edit_wars.22_or_other_conflicts">
155      Resolving "edit wars" or other conflicts
156    </h3>
157    <p>
158      If for whatever reason you end up in an "edit war" on a pag
>e, where two or more people are continually and repeatedly making 
> and reverting changes, please try to resolve the conflict with t 
>he people involved first. 
159    </p>
160    <p>
161      Should no resolution be possible, please bring it to the at
>tention of either (ideally) the <a href="Project:en/Community">MD 
>C mailing list</a> or (as a last resort) the <a href="User:Sheppy 
>">developer documentation lead</a>. Other technical experts, writ 
>ers, and editors will be consulted as required, and their experti 
>se will be used to resolve the problem. 
162    </p>
163    <h3 name="Requesting_page_deletions">
164      Requesting page deletions
165    </h3>
166    <p>
167      Should you create a page by accident or stumble across a pa
>ge you think should be deleted, mark it as such by adding the "Ju 
>nk" tag to it. 
168    </p>
169    <p>
170      Items tagged as <a class="internal" href="/Special:Tags?tag
>=Junk" title="Special:Tags?tag=Junk">Junk</a> are checked periodi 
>cally by wiki administrators and the pages it contains are evalua 
>ted and deleted when appropriate. 
171    </p>
172    <div class="note">
173      <strong>Note</strong>: Please do not delete other content o
>r categories from the pages you flag as "Junk". 
174    </div>
175    <h3 name="Joining_the_MDC_community">
176      Joining the MDC community
177    </h3>
178    <p>
179      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. 
180    </p>
181    <h4 name="Mailing_list_.2F_newsgroup">
182      Mailing list / newsgroup
183    </h4>
184    <ul>
185      <li>View MDC forums...
186      </li>
187    </ul>
188    <p>
189      {{ DiscussionList("dev-mdc", "") }}
190    </p>
191    <h4 name="IRC_channel">
192      IRC channel
193    </h4>
194    <p>
195      We also hang out on the server in the #devm
>o channel: <a class="link-irc" href="irc://" 
>>#devmo on</a>. 
196    </p>
197    <h4 name="Project_lead">
198      Project lead
199    </h4>
200    <p>
201      The MDC and developer documentation is overseen by <a class
>="link-mailto" href="">Eric Shepherd< 
202    </p>{{ languages( { "es": "Project:es/Primeros_Pasos", "fr": 
>"Project:fr/Pour_commencer", "ja": "Project:ja/Getting_started",  
>"pl": "Project:pl/Na_pocz\u0105tek", "pt": "Project:pt/Como_come\ 
>u00e7ar", "zh-cn": "Project:cn/\u73b0\u5728\u5c31\u5f00\u59cb" }  
>) }} 

Back to History