Compare Revisions

MDN:How to help

Revision 372541:

Revision 372541 by netfuzzer55 on

Revision 372581:

Revision 372581 by fscholz on

Title:
MDN:How to help
MDN:How to help
Slug:
Project:How_to_Help
Project:How_to_Help
Tags:
"MDC Project"
"MDC Project"
Content:

Revision 372541
Revision 372581
tt7    <div class="callout-box">
8      <strong><a href="/docs/Project:Getting_started">Getting sta
 >rted</a></strong><br>
9      Do you want to help make MDC even better? Here's how to get
 > started.
10    </div>
11    <div>
12      <p>
13        The <strong>Mozilla Developer Network</strong> (MDN) supp
 >orts the growth and development of Firefox and the web by providi
 >ng comprehensive, accurate, and up-to-date information about Fire
 >fox, Mozilla, and web development technologies. Mozilla Documenta
 >tion Center (MDC) is the documentation section of MDN.
14      </p>
15      <p>
16        If you're looking for technical help, try <a href="/docs"
 > title="en">browsing</a> or <a href="/search" title="Special:Nutc
 >h">searching the site</a>. Technical questions should be directed
 > to one of the <a href="http://www.mozilla.org/community/develope
 >r-forums.html">Mozilla development forums</a>.
17      </p>
18      <p>
19        User questions can be asked on one of the <a class="exter
 >nal" href="http://www.mozilla.org/support/">end-user support foru
 >ms</a>.
20      </p>
21      <h2 id="I_found_some_wrong_or_out-of-date_info._What_should
 >_I_do.3F">
22        I found some wrong or out-of-date info. What should I do?
23      </h2>
24      <p>
25        Ideally, it would be great if you would just fix it. MDC 
 >is a wiki, after all. For typos and other minor things, it's real
 >ly quicker to fix it than to tell someone about it.
26      </p>
27      <p>
28        But that's not always realistic. Maybe you came to MDC to
 > quickly find some info while in the middle of some other task, a
 >nd you don't want to interrupt your flow. Or maybe you can tell t
 >hat something's not right, but you don't personally know all the 
 >correct info. There are a few ways you can flag a problem to hope
 >fully be fixed by someone else, including Bugzilla and tagging.
29      </p>
30      <h3 id="Bugzilla">
31        Bugzilla
32      </h3>
33      <p>
34        If you don't know what Bugzilla is, you can safely ignore
 > this section. If you're the kind of person who lives and breathe
 >s in Bugzilla, you can <a href="https://bugzilla.mozilla.org/ente
 >r_bug.cgi?product=Developer%20Documentation">file a documentation
 > bug</a>. Use these field values:
35      </p>
36      <dl>
37        <dt>
38          classification
39        </dt>
40        <dd>
41          Other
42        </dd>
43        <dt>
44          product
45        </dt>
46        <dd>
47          Developer Documentation
48        </dd>
49        <dt>
50          URL
51        </dt>
52        <dd>
53          The page where you found the problem
54        </dd>
55        <dt>
56          Description
57        </dt>
58        <dd>
59          As much as you know or have time to describe about the 
 >problem and where to find correct information. This can include p
 >eople ("talk to so-and-so") as well as Web links.
60        </dd>
61      </dl>
62      <h3 id="Tagging">
63        Tagging
64      </h3>
65      <p>
66        If you're not a Bugzilla maven, you can use tags within M
 >DC to flag problems. Here are some of the tags we use, and their 
 >meanings:
67      </p>
68      <ul>
69        <li>
70          <strong>NeedsMarkupWork</strong>: the formatting is not
 > standard or not consistent with other pages.
71        </li>
72        <li>
73          <strong>NeedsExample</strong>: needs one or more illust
 >rative code examples of the item documented.
74        </li>
75        <li>
76          <strong>NeedsContent</strong>: the item is incomplete a
 >nd needs to be filled out.
77        </li>
78        <li>
79          <strong>NeedsJSVersion</strong>: needs information abou
 >t the version of JavaScript and EcmaScript this item first appear
 >s in.
80        </li>
81        <li>
82          <strong>NeedsBrowserCompatibility</strong>: needs a bro
 >wser compatibility table or needs the table filled out.
83        </li>
84        <li>
85          <strong>MakeBrowserAgnostic</strong>: the article is wr
 >itten with a focus on Gecko, when it is actually about a standard
 > function or feature, which should be rewritten to be generic.
86        </li>
87      </ul>
88      <div class="table-layout">
89        <h4 id="To_add_tags">
90          To add tags
91        </h4>
92        <ol>
93          <li>Login to MDN.
94          </li>
95          <li>Click Edit to enter editing mode.
96          </li>
97          <li>Scroll to the bottom of the page.
98          </li>
99          <li>In the Tags box, type the tag that you want to add.
 > Tags can contain spaces.
100          </li>
101          <li>Press Enter to accept the tag.
102          </li>
103          <li>Click Save Changes when you are done.
104          </li>
105        </ol>
106        <h4 id="To_remove_tags">
107          To remove tags
108        </h4>
109        <ol>
110          <li>Login to MDN.
111          </li>
112          <li>Click Edit to enter editing mode.
113          </li>
114          <li>Scroll to the bottom of the page.
115          </li>
116          <li>Click the X next to the tag you want to delete.
117          </li>
118          <li>Click Save Changes when you are done.
119          </li>
120        </ol>
121      </div><!--
122  <h2 id="Talk_pages">Talk pages</h2>
123  <p>Sometimes just adding a tag does not provide sufficient info
 >rmation about a problem for someone else to fix it. You can use t
 >he Talk page associated with a content page on MDC to explain mor
 >e.</p>
124  <p>To edit a Talk page:</p>
125  <ol>
126    <li>In the upper right corner of the page (beneath the MDN he
 >ader), click This page &gt; Talk page. The corresponding Talk pag
 >e opens.</li>
127    <li>Click the Edit button. The page editor opens.</li>
128    <li>Type your comment, explaining what needs to be fixed abou
 >t the content page.</li>
129    <li>Use four tildes in a row (<span class="nowiki">~~~~</span
 >>) to insert a timestamp with your user ID. This tells other peop
 >le who left the comment, and when.</li>
130    <li>Click Save in the editor toolbar when you are done.</li>
131  </ol>
132-->
133      <h2 id="I_want_to_dive_in!">
134        I want to dive in!
135      </h2>
136      <p>
137        If you'd like to help make the content on MDC better, the
 >re are several ways you can contribute. You can write new content
 >, copy-edit and correct existing material, or translate material 
 >into new languages. Check out <a href="/Project:en/Getting_starte
 >d" title="Project:en/Getting_started">Getting started</a> for det
 >ails.
138      </p>
139    </div>
140    <div class="cleared topicpage-table">
141      <div class="section">
142        <h2 id="Documentation">
143          Documentation
144        </h2>
145        <dl>
146          <dt>
147            Lists
148          </dt>
149          <dd>
150            <a href="/en-US/docs/Project:Documentation_Wishlist">
 >Documentation wishlist</a>
151          </dd>
152          <dd>
153            <a href="/en-US/docs/Project:To-do_list">Editing/revi
 >ew to do list</a>
154          </dd>
155          <dd>
156            <a href="/en-US/docs/Project:Existing_Content">Migrat
 >ion list</a>
157          </dd>
158          <dd>
159            <a href="http://bugzilla.mozilla.org/buglist.cgi?keyw
 >ords=dev-doc-needed">Bugzilla doc-needed list</a> and <a href="/e
 >n-US/docs/Project:Notes_on_doc-needed_bugs">Notes on doc-needed b
 >ugs</a>
160          </dd>
161        </dl>
162        <dl>
163          <dt>
164            Guides
165          </dt>
166          <dd>
167            <a href="/en-US/docs/Project:Getting_started">Getting
 > started</a>
168          </dd>
169          <dd>
170            <a href="/en-US/docs/Project:MDC_style_guide">Writer'
 >s guide</a>
171          </dd>
172          <dd>
173            <a href="/en-US/docs/Project:Topic_drivers">Topic dri
 >vers</a>
174          </dd>
175          <dd>
176            <a href="/en-US/docs/Project:Page_Naming_Guide">Page 
 >naming guide</a>
177          </dd>
178          <dd>
179            <a href="/en-US/docs/Project:Tracking_documentation_i
 >ssues">Tracking documentation issues</a>
180          </dd>
181          <dd>
182            <a href="/en-US/docs/Project:Writing_interface_refere
 >nce_documentation">Writing interface reference documentation</a>
183          </dd>
184          <dd>
185            <a href="/en-US/docs/Project:Compatibility_tables">Co
 >mpatibility tables</a>
186          </dd>
187          <dd>
188            <a href="/en-US/docs/Project:Disambiguation">Disambig
 >uation pages</a>
189          </dd>
190          <dd>
191            <a href="/en-US/docs/Project:Localization_Projects">S
 >tarting a new MDC localization</a>
192          </dd>
193          <dd>
194            <a href="/en-US/docs/Project:Newsgroup_summaries">Cre
 >ating newsgroup summaries</a>
195          </dd>
196          <dd>
197            <a href="/en-US/docs/Project:Creating_FAQs">Creating 
 >FAQs</a>
198          </dd>
199          <dd>
200            <a href="/en-US/docs/Project:Copyrights">Copyrights a
 >nd licensing</a>
201          </dd>
202        </dl>
203        <dl>
204          <dt>
205            References
206          </dt>
207          <dd>
208            <a href="/en-US/docs/Project:MDC_style_guide">MDC sty
 >le guide</a>
209          </dd>
210          <dd>
211            <a href="/en-US/docs/Project:MDC_editor_guide">MDC ed
 >itor guide</a>
212          </dd>
213          <dd>
214            <a href="/en-US/docs/Project:Custom_CSS_Classes">Cust
 >om CSS classes</a>
215          </dd>
216          <dd>
217            <a href="/en-US/docs/Project:Custom_Templates">Custom
 > templates</a>
218          </dd>
219          <dd>
220            <a href="/en-US/docs/Project:External_Redirects">Exte
 >rnal redirects</a>
221          </dd>
222          <dd>
223            <a href="/en-US/docs/Project:Needs_Redirect">Needs re
 >direct</a>
224          </dd>
225        </dl>
226        <p>
227          <span class="alllinks"><a href="/Special:Tags" title="S
 >ite Tags">View All...</a></span>
228        </p>
229      </div>
230      <div class="section">
231        <h2 id="Community">
232          Community
233        </h2>
234        <div class="note">
235          For technical discussions about Mozilla technology, ple
 >ase use <a class="external" href="http://www.mozilla.org/communit
 >y/developer-forums.html">one of the Mozilla development forums</a
 >>.
236        </div>
237        <p>
238          You can read and post discussions about MDN documentati
 >on:<br>
239          {{ DiscussionList("dev-mdc", "mozilla.dev.mdc") }}
240        </p>
241        <ul>
242          <li>
243            <a class="link-irc" href="irc://irc.mozilla.org/devmo
 >">#devmo on irc.mozilla.org</a>
244          </li>
245          <li>
246            <a class="link-mailto" href="mailto:eshepherd@mozilla
 >.com">Eric Shepherd, Developer Documentation Lead</a>
247          </li>
248          <li>
249            <a href="/en-US/docs/Project:Promote_MDC">Promote MDC
 ></a>
250          </li>
251        </ul>
252        <h2 id="Tools">
253          Tools
254        </h2>
255        <ul>
256          <li>
257            <a href="http://wikipedia.mozdev.org/">Wikipedia tool
 >bar Firefox extension</a>
258          </li>
259          <li>
260            <a href="http://spellbound.sourceforge.net/">Spellbou
 >nd spell-checker Firefox extension</a>
261          </li>
262        </ul>
263        <h2 id="Related_Topics">
264          Related Topics
265        </h2>
266        <ul>
267          <li>
268            <a href="/en-US/docs/Project:Frequently_Asked_Questio
 >ns">MDC FAQ</a>
269          </li>
270          <li>
271            <a href="/Special:Tags?tag=MDC_Project&amp;language=e
 >n" title="Special:Tags?tag=MDC Project&amp;language=en">MDC proje
 >ct pages</a>
272          </li>
273        </ul>
274      </div>
275    </div>
276    <p>
277      &nbsp;
278    </p>

Back to History