/[gentoo]/xml/htdocs/proj/en/gdp/doc/doc-policy.xml
Gentoo

Diff of /xml/htdocs/proj/en/gdp/doc/doc-policy.xml

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.12 Revision 1.28
1<?xml version='1.0' encoding="UTF-8"?> 1<?xml version='1.0' encoding="UTF-8"?>
2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-policy.xml,v 1.12 2005/05/12 09:56:52 neysx Exp $ --> 2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-policy.xml,v 1.28 2013/03/31 13:00:52 swift Exp $ -->
3
4<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> 3<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
5 4
6<guide link="doc-policy.xml"> 5<guide>
7
8<title>Gentoo Linux Documentation Policy</title> 6<title>Gentoo Linux Documentation Policy</title>
7
9<author title="Author"> 8<author title="Author">
10 <mail link="zhen@gentoo.org">John P. Davis</mail> 9 <mail link="neysx@gentoo.org">Xavier Neys</mail>
11</author> 10</author>
11<author title="Author">John P. Davis</author>
12<author title="Author"> 12<author title="Author">
13 <mail link="swift@gentoo.org">Sven Vermeulen</mail> 13 <mail link="swift@gentoo.org">Sven Vermeulen</mail>
14</author> 14</author>
15<author title="Editor"> 15<author title="Editor">
16 <mail link="spyderous@gentoo.org">Donnie Berkholz</mail> 16 <mail link="dberkholz@gentoo.org">Donnie Berkholz</mail>
17</author> 17</author>
18
19<!-- The content of this document is licensed under the CC-BY-SA license -->
20<!-- See http://creativecommons.org/licenses/by-sa/2.0 -->
21 18
22<abstract> 19<abstract>
23This document contains the Gentoo Documentation Policy, which is the 20This document contains the Gentoo Documentation Policy, which is the
24base document which all Gentoo Documentation developers and 21base document which all Gentoo Documentation developers and
25Contributers should know and exercise. 22Contributors should know and exercise.
26</abstract> 23</abstract>
27 24
25<!-- The content of this document is licensed under the CC-BY-SA license -->
26<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
28<license/> 27<license/>
29 28
30<version>3.11</version> 29<version>9</version>
31<date>2005-05-07</date> 30<date>2013-03-31</date>
32 31
33<chapter> 32<chapter>
34<title>Introduction</title> 33<title>Introduction</title>
35<section> 34<section>
36<title>Introduction</title> 35<title>Introduction</title>
37<body> 36<body>
38 37
39<p> 38<p>
40The Gentoo Linux Documentation team aspires to create exceptionally 39The Gentoo Linux Documentation team aspires to create exceptionally
41professional documentation that is immediately clear and concise to the 40professional documentation that is immediately clear and concise to the
42end user. In order to fulfill this goal, we have very specific rules and 41end user. In order to fulfill this goal, we have very specific rules and
43guidelines that <e>all</e> documentation must go through before it is 42guidelines that our documentation must go through prior to
44published on our website, or otherwise. 43dissemination on our website, or elsewhere.
45</p> 44</p>
46 45
47</body> 46</body>
48</section> 47</section>
49<section> 48<section>
50<title>Covered Topics</title> 49<title>Covered Topics</title>
51<body> 50<body>
52 51
53<p> 52<p>
54This policy will cover these topics: 53This policy will cover the following topics:
55</p> 54</p>
56 55
57<ul> 56<ul>
58<li>Documentation Project Team Organization</li> 57<li>Documentation Project Team Organization</li>
59<li>Documentation Guidelines</li> 58<li>Documentation Guidelines</li>
60<li>Documentation Team Recruitement</li> 59<li>Documentation Team Recruitment</li>
61</ul> 60</ul>
62 61
63</body> 62</body>
64</section> 63</section>
65</chapter> 64</chapter>
69<section> 68<section>
70<title>Organization</title> 69<title>Organization</title>
71<body> 70<body>
72 71
73<p> 72<p>
74The Gentoo Documentation Project Team is split into several smaller teams 73The Gentoo Documentation Project Team consists of editors and authors, working
75that operate in complete cooperation with each other. Each smaller team 74on our main documentation and its translations. Like most other Gentoo projects,
76represents an active development team of a Gentoo Documentation 75it is led by a project lead whose additional job is to look after the team and
77Subproject. 76its resources in general (such as focusing on recruitment when necessary and
78</p> 77taking final decisions when consensus about doc-related issues cannot be found
79 78otherwise).
80<p> 79</p>
81The Gentoo Documentation Project is strategically lead by a top-level manager 80
82as required by the <uri link="/doc/en/management-structure.xml">Gentoo
83Management Structure</uri>. This document also describes the responsibilities
84of the strategic manager with respect to Gentoo Linux.
85</p> 81<p>
86 82When the Gentoo Documentation Team launches any subprojects, you will find its
87<p> 83mission on our <uri link="/proj/en/gdp/">GDP Project Webpage</uri>, along with
88For day-to-day managerial tasks the Gentoo Documentation Project has an 84their respective project leads.
89operational manager. This person keeps track of all documentation-related tasks
90that are more short-term. The operational manager and strategic manager can be
91one and the same if the strategic manager wishes so.
92</p>
93
94<p>
95Currently these positions are taken by the following people:
96</p>
97
98<table>
99<tr>
100 <th>Position</th>
101 <th>Developer Name</th>
102 <th>Developer Nick</th>
103</tr>
104<tr>
105 <ti>Strategic Manager</ti>
106 <ti>Sven Vermeulen</ti>
107 <ti><mail link="swift@gentoo.org">swift</mail></ti>
108</tr>
109<tr>
110 <ti>Operational Manager</ti>
111 <ti>Xavier Neys</ti>
112 <ti><mail link="neysx@gentoo.org">neysx</mail></ti>
113</tr>
114</table>
115
116<p>
117Every subproject has a strategic manager of its own. he can have an operational
118manager if he deems appropriate. His responsibilities to the Gentoo
119Documentation Project are the same as are listed on the <uri
120link="/doc/en/management-structure.xml#doc_chap1_sect5">Gentoo Management
121Structure</uri>.
122</p>
123
124<p>
125The subprojects of the Gentoo Documentation Team together with their respective
126strategic managers are listed on the <uri link="/proj/en/gdp/">GDP
127Website</uri>.
128</p>
129
130<p>
131The decision on adding subprojects is in hands of the strategic manager.
132</p> 85</p>
133 86
134</body> 87</body>
135</section> 88</section>
136<section> 89<section>
137<title>Documentation Project Team Members</title> 90<title>Documentation Project Team Members</title>
138<body> 91<body>
139 92
140<p> 93<p>
141Every member of the Gentoo Documentation Project must be subscribed to 94Every member of the Gentoo Documentation Project must be subscribed to
142the <mail link="gentoo-doc-subscribe@gentoo.org">gentoo-doc@gentoo.org</mail> 95the <mail link="gentoo-doc+subscribe@gentoo.org">gentoo-doc@gentoo.org</mail>
143mailing list. This mailing list will be used to discuss all 96mailing list. This mailing list will be used to discuss all
144documentation-related issues. This mailing list is open to all interested 97documentation-related issues. This mailing list is open to all interested
145parties, developer or not. 98parties, developer or not.
146</p> 99</p>
147 100
148<p> 101<p>
149Every member of the Gentoo Documentation Project must be part of the 102Every member of the Gentoo Documentation Project must be part of the
150<mail link="docs-team@gentoo.org">docs-team@gentoo.org</mail> alias. This 103<mail>docs-team@gentoo.org</mail> alias. This alias is <e>only</e> used by <uri
151alias is <e>only</e> used by <uri
152link="http://bugs.gentoo.org">bugs.gentoo.org</uri> to inform the documentation 104link="http://bugs.gentoo.org">bugs.gentoo.org</uri> to inform the documentation
153team about bugs regarding the Gentoo Documentation. You can add yourself by 105team about bugs regarding the Gentoo Documentation. You can add yourself by
154editing <path>/var/mail/alias/misc/docs-team</path> on dev.gentoo.org. 106editing <path>/var/mail/alias/misc/docs-team</path> on dev.gentoo.org. Please do
155</p> 107<e>not</e> use this address to try and contact the team - you can contact us
156 108through the mailinglist, IRC or by mailing the project lead or any other member.
157<p> 109</p>
158Every member of the Gentoo Documentation Team should be available at 110
111<p>
112Members of the Gentoo Documentation Team are frequently online in
159<c>#gentoo-doc</c> on <uri link="http://www.freenode.net">irc.freenode.net</uri> 113<c>#gentoo-doc</c> on <uri link="http://www.freenode.net">irc.freenode.net</uri>.
160whenever he is online.
161</p>
162
163<p> 114</p>
164Depending on his responsibilities, he can have limited CVS 115
165access to <c>cvs.gentoo.org</c>. Full CVS access can only be given to Gentoo 116<p>
166developers. Read-only CVS access can be given to recruitees. 117Depending on the assignment or responsibilities, a member may have CVS
118access to <c>cvs.gentoo.org</c>. Interested non-developers can use the
119<uri link="http://anoncvs.gentoo.org">anonymous CVS server</uri>
120to help out with the documentation. It contains the same files as our CVS
121server but is a few minutes late.
167</p> 122</p>
168 123
169</body> 124</body>
170</section> 125</section>
171<section> 126<section>
172<title>Documentation Translation Teams</title> 127<title>Documentation Translation Teams</title>
173<body> 128<body>
174 129
175<p> 130<p>
176Every language should be backed up by an official translation team. This 131Every language should be backed up by an official Translation Team. This
177team is lead by a lead translator and perhaps a follow-up lead translator, who 132team is led by a <e>Lead Translator</e> and perhaps a <e>Follow-On Lead
178both have CVS commit access. If for any reason the lead translator cannot 133Translator</e>, who both have CVS commit access. Organization of the
179perform his or her duties, the follow-up lead translator is in charge. If 134translations is handled by the lead translator as he or she sees fit, as
180even this person is unavailable, the mentor(s) is/are in charge of the language. 135long as the committed translations follow this policy.
181</p>
182
183<p> 136</p>
184If a translated document is contributed, but the language in itself is 137
185not supported, the Gentoo Documentation Team will not publish it
186officially. In this case the document will stay unlinked until an official
187translation team of that language is formed.
188</p> 138<p>
189 139If a translated document for an unsupported language is contributed, the Gentoo
140Documentation Team will publish it as-is. Such documents will not be linked to
141the website until an official Translation Team of that language is formed, but
142they will be available on our site and in CVS.
190<p> 143</p>
191When a language is officially supported, but the team doesn't have any 144
192members or no one wants to take on the responsibilities of the lead 145<p>
193translator, all links to the documents will be removed from the site. 146For more information Gentoo document translations, please consult the
194However, the documents will stay available in case the language becomes 147<uri link="/proj/en/gdp/doc/translators-howto.xml">
195officially supported again. 148Translators Howto for Gentoo Documentation</uri> and the
149<uri link="/proj/en/gdp/international.xml">
150GDP Internationalisation Subproject</uri> page.
196</p> 151</p>
197 152
198</body> 153</body>
199</section> 154</section>
200</chapter> 155</chapter>
205<title>Legal Issues</title> 160<title>Legal Issues</title>
206<body> 161<body>
207 162
208<p> 163<p>
209Every document published by the Gentoo Documentation Project must be 164Every document published by the Gentoo Documentation Project must be
210licensed by the <uri 165licensed by the <uri
211link="http://creativecommons.org/licenses/by-sa/2.0/">Creative Commons 166link="http://creativecommons.org/licenses/by-sa/3.0/">Creative Commons
212Attribution-ShareAlike License</uri>. 167Attribution-ShareAlike License</uri>, preferably the latest version (although
168earlier versions are supported too).
213</p> 169</p>
214 170
215<p> 171<p>
216Every document must have the following tag inside its GuideXML 172Every document must have the following tag inside its GuideXML
217sourcecode between the <c>&lt;/abstract&gt;</c> and the <c>&lt;version&gt;</c> 173source code between the <c>&lt;/abstract&gt;</c> and the <c>&lt;version&gt;</c>
218tags: 174tags:
219</p> 175</p>
220 176
221<pre caption = "Licensing notice for the Gentoo Documentation"> 177<pre caption="Licensing notice for the Gentoo Documentation">
222&lt;/abstract&gt; 178&lt;/abstract&gt;
223<i> 179<i>
224&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt; 180&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt;
225&lt;!-- See http://creativecommons.org/licenses/by-sa/2.0 --&gt; 181&lt;!-- See http://creativecommons.org/licenses/by-sa/3.0 --&gt;
226&lt;license/&gt; 182&lt;license version="3.0"/&gt;
227</i> 183</i>
228&lt;version&gt;...&lt;/version&gt; 184&lt;version&gt;...&lt;/version&gt;
229</pre> 185</pre>
230 186
187<p>
188If the 2.5 version is used, the tag can be either <c>&lt;license /&gt;</c> or
189<c>&lt;license version="2.5" /&gt;</c>. In either case must the comment be
190updated to refer to the correct version URL.
191</p>
192
231</body> 193</body>
232</section> 194</section>
233<section> 195<section>
234<title>Bugs and Updates</title> 196<title>Bugs and Updates</title>
235<body> 197<body>
236 198
237<p> 199<p>
238Every bug reported on <uri link="http://bugs.gentoo.org">bugs.gentoo.org</uri> 200Every bug reported on <uri link="http://bugs.gentoo.org">bugs.gentoo.org</uri>
239should be handled as fast as possible. If a bug cannot be handled 201should be handled as fast as possible. If a bug cannot be handled
240in a timely fashion, the reporter of that bug should be informed about 202in a timely fashion, the reporter of that bug should be informed about
241this using a comment on the bug and the bug should be registered in the 203this using a comment on the bug.
242<uri link="/proj/en/gdp/doc/metadoc-guide.xml">metadoc.xml</uri> file, if
243applicable. The tactical or operational manager can decide that a bug has a
244higher priority and should be handled first before any other task the assingee
245is responsible of.
246</p>
247
248<p> 204</p>
205
206<p>
249Whenever a Gentoo Documentation Team member takes care of a bug, he or 207Whenever a Gentoo Documentation Team member takes care of a bug, he or she
250she should assign the bug to herself/himself, but make sure that 208should assign the bug to herself/himself, but make sure that
251<c>docs-team@gentoo.org</c> is on the Cc-list. Unless with the consent 209<mail>docs-team@gentoo.org</mail> is on the Cc-list. A bug may not be taken
252of the operational manager, a bug may not be taken away from another
253Gentoo Documentation Team member without their approval. 210away from another Gentoo Documentation Team member without their approval
211unless consent has been received from the project lead.
254</p> 212</p>
255 213
256</body> 214</body>
257</section> 215</section>
258<section> 216<section>
259<title>Document Development</title> 217<title>Document Development</title>
260<body> 218<body>
261 219
262<p> 220<p>
263Every document the Gentoo Documentation Team develops can be developed as the 221Every Gentoo Documentation Team may handle documentation development as it sees
264related parties see fit. However, when the document is finished, it should be 222fit. However, when the document is finished, it should be transformed into
265transformed into <uri link="/doc/en/xml-guide.xml">GuideXML</uri> and put 223<uri link="/doc/en/xml-guide.xml">GuideXML</uri> and made available on the
266available on the Gentoo CVS infrastructure. It must also be registered in the 224Gentoo CVS infrastructure. It must also be registered in the
267<uri link="/proj/en/gdp/doc/metadoc-guide.xml">metadoc.xml</uri> file if 225<uri link="/proj/en/gdp/doc/metadoc-guide.xml">metadoc.xml</uri> file if
268applicable. 226applicable.
269</p> 227</p>
270 228
271<p> 229<p>
272When a new document is started or a big change is needed, a bug should be filed 230When a new document is started or a big change is needed, a bug should be filed
273at <uri link="http://bugs.gentoo.org">bugs.gentoo.org</uri> 231at <uri link="http://bugs.gentoo.org">bugs.gentoo.org</uri>
274concerning the development of this document. If there is already a bug 232concerning the development of this document. If there is already a bug
275in the database that requests a change to the documentation, a new bug 233in the database that requests a change to the documentation, a new bug
276does not have to be filed. Grammatical, syntactical or small changes 234does not have to be filed. Grammatical, syntactical or small changes
277do not require a bug to be filed on <uri 235do not require a bug to be filed on <uri
278link="http://bugs.gentoo.org">bugs.gentoo.org</uri> as well. 236link="http://bugs.gentoo.org">bugs.gentoo.org</uri> as well.
279</p> 237</p>
280 238
281<p> 239<p>
282All changes in contents of the document, except for typo fixes in text 240All changes in contents of the document, except for typo fixes in text itself
283itself or in the comments to code listings, should lead to version 241or in the comments to code listings, should lead to version number and date
284number (and date) increase. Note that the change of a Code Listings should 242increase. Note that the change of a Code Listings should definitely cause an
285definitely cause an increase of the version number and date. 243increase of the version number and date.
286</p>
287
288<p> 244</p>
245
246<p>
289All changes in XML formatting should lead to version (and date) bumps only in 247All changes in XML formatting should lead to version and date bumps only in
290case the layout of the document changes. 248case the layout of the HTML document changes.
291</p>
292
293<p> 249</p>
294Whether or not to increment the major version number instead of minor version 250
295number or other is up to the editor.
296</p> 251<p>
297 252Versions should always be handled as integers, so a version bump of version
253<c>2</c> leads to version <c>3</c>. Historical versions that use the major and
254minor syntax should be converted to the next integer on the next update, so
255version <c>3.2</c> becomes version <c>4</c>.
298<p> 256</p>
257
258<p>
299Every update of a translation should copy the new version information 259Every update of a translation should use the version and date information
300verbatim from the master English document so fully synchronised 260verbatim from the master English document so fully synchronised translations
301translations have the same version information. 261have the same version and date.
302</p> 262</p>
303 263
304</body> 264</body>
305</section> 265</section>
306<section> 266<section>
307<title>Reviewing and Committing</title> 267<title>Reviewing and Committing</title>
308<body> 268<body>
309 269
310<p> 270<p>
311To keep a high-pace development cycle of the documentation, technical or 271To maintain a high-paced documentation development cycle, technical or
312intrusive changes to documents can be propagated immediately to the document 272intrusive changes to documents can be propagated immediately to the document.
313<e>if</e> the editor is 100% confident his changes are correct and working. If 273This is allowed only <e>if</e> the editor is absolutely confident the changes
314you are not 100% confident (for instance because a user has told you how to fix 274are functionally correct. If you are not absolutely confident (for instance because a
315it but you cannot verify yourself), have the change reviewed by a Gentoo 275user has told you how to fix it but you cannot verify yourself), have the
316Developer that can verify the change. 276changes reviewed by a third person that can verify the changes are apt.
317</p>
318
319<p> 277</p>
278
279<p>
320High volume, technical or intrusive changes must be accompanied by a bugreport 280High-volume, technical or intrusive changes must be accompanied by a bug report
321on <uri>http://bugs.gentoo.org</uri>. This bugnumber <e>must</e> be mentioned in 281on <uri>http://bugs.gentoo.org</uri>. This bug number <e>must</e> be mentioned
322the CVS log to allow backtracing of changes. 282in the CVS log to allow backtracing of changes.
323</p>
324
325<p> 283</p>
326If a bugfix consists out of both content as internal coding changes, 284
327both changes must be committed separately so that translators can easily
328view the important changes (content) and ignore the coding changes.
329</p> 285<p>
330 286If a bugfix includes changes to content as well as internal coding changes,
331<p> 287both changes must be committed separately. This allows translators to focus
332In case of a translation, the lead translator of the language is 288on the relevant changes regarding content and ignore the coding changes.
333responsible for the document. Only he may commit the document to CVS
334unless he is currently "in training", in which case his or her
335mentor should commit it.
336</p> 289</p>
337 290
338</body> 291</body>
339</section> 292</section>
340<section> 293<section>
341<title>Sanctions</title> 294<title>Sanctions</title>
342<body> 295<body>
343 296
344<p> 297<p>
345Although this has never been necessary, it is still important to list this in 298Malicious conduct by developers has not been an issue before. However, it
346the policy - even though it is hateful. Anyway, documentation developers that 299should be noted that documentation developers that misuse their position by
347misuse their position by
348</p> 300</p>
349 301
350<ul> 302<ul>
351 <li>deliberately providing wrong information to users or developers</li> 303 <li>deliberately providing wrong information to users or developers</li>
352 <li>deliberately writing flawed documentation</li> 304 <li>deliberately writing flawed documentation</li>
353 <li>deliberately corrupting documents</li> 305 <li>deliberately corrupting documents</li>
354 <li> 306 <li>
355 deliberately go against the decisions made policy-wise or through a 307 deliberately go against the decisions made policy-wise or through a
356 consensus-model on the Gentoo Documentation mailinglist 308 consensus-model on the Gentoo Documentation mailinglist
357 </li> 309 </li>
358 <li>
359 not performing at all for a long time without informing the GDP and without 310 <li>not performing at all for a long time without informing the GDP</li>
360 replying to the operational manager's request for a status update
361 </li>
362</ul> 311</ul>
363 312
364<p> 313<p>
365will be reported to the <uri link="/proj/en/devrel/">Gentoo Developer 314will be reported to the <uri link="/proj/en/devrel/">Gentoo Developer
366Relations</uri> project. 315Relations</uri> project.
369</body> 318</body>
370</section> 319</section>
371</chapter> 320</chapter>
372 321
373<chapter> 322<chapter>
374<title>Documentation Team Recruitement</title> 323<title>Documentation Team Recruitment</title>
375<section> 324<section>
376<title>Contributors, Authors, Translators</title> 325<title>Contributors, Authors, Translators</title>
377<body> 326<body>
378 327
379<p> 328<p>
380Everyone interested in contributing documentation, editing existing 329Everyone interested in contributing documentation, editing existing
381documentation, writing new documentation or translating documentation is 330documentation, writing new documentation or translating documentation is
382welcome to join the team. There are no rules or strings attached to 331welcome to send their contributions. There are no rules or strings attached to
383this. Just make sure you are subscribed to <c>gentoo-doc@gentoo.org</c> 332this. Just make sure you are subscribed to <mail>gentoo-doc@gentoo.org</mail>,
384and you have fully read this policy and understand it. 333and you have fully read this policy and understand it.
385</p> 334</p>
386 335
387</body> 336</body>
388</section> 337</section>
389<section> 338<section>
390<title>Recruitment Process</title> 339<title>Recruitment Process</title>
391<body> 340<body>
392 341
393<p> 342<p>
394The Documentation Project has a strict recruitment process outlined below. 343The Documentation Project uses the recruitment process outlined below.
395This process can not be deviated from in any circumstance. We have opted for
396this recruitment process to assure ourselves that the recruitee is well informed 344We have opted for this recruitment process to assure ourselves that the recruit
397about the Gentoo Documentation Policy and the Gentoo Coding Style. It has proven 345is well informed about the Gentoo Documentation Policy and the Gentoo Coding
398to be quite effective even though many contributors see it as a too large burden 346Style. It has proven to be quite effective even though many contributors see it
399to cross. 347as a too large burden to cross.
400</p> 348</p>
401 349
402<p> 350<p>
403This recruitment process is meant only for requests to the Gentoo Documentation 351This recruitment process is meant only for requests to the Gentoo Documentation
404Repository through CVS. Being listed as the maintainer or Point-Of-Contact for a 352Repository through CVS. Being listed as the maintainer or point of contact for
405certain document or range of documents is granted by a simple request to the 353a certain document or range of documents does not require developer access.
406Operational Manager or Project Lead.
407</p> 354</p>
408 355
409</body> 356</body>
410</section> 357</section>
411<section> 358<section>
413<body> 360<body>
414 361
415<p> 362<p>
416No recruitment process starts without investigating the contributions done 363No recruitment process starts without investigating the contributions done
417already to the Gentoo Documentation Project. The number of contributions must be 364already to the Gentoo Documentation Project. The number of contributions must be
418large to assure a good knowledge of GuideXML, Coding Style and policy. The 365large to assure a good knowledge of GuideXML, Coding Style and policy. The
419contribution period must be large as well to inform the contributor about the 366contribution period must be large as well to allow the contributor to find out
420time-consuming position and pressure the application involves. 367if he can provide continuous support for the Gentoo Documentation Project.
421</p>
422
423<p> 368</p>
424The number of contributions and period over which the contributions should be
425made depends on the position which the contributor solicits for. Although it is
426difficult to write down these measurements in numbers, the following table
427should give a general overview. Final decision however lays in the hands of the
428Operational Manager.
429</p>
430
431<table>
432<tr>
433 <th>Position</th>
434 <th>Minimal Activity</th>
435 <th>Minimal Period</th>
436</tr>
437<tr>
438 <ti>Full-time Developer</ti>
439 <ti>2 updates per week</ti>
440 <ti>1 month</ti>
441</tr>
442<tr>
443 <ti>Part-time Developer</ti>
444 <ti>4 updates per month</ti>
445 <ti>1 month</ti>
446</tr>
447</table>
448 369
449<p> 370<p>
450An update constitutes a non-trivial update to any documentation, translation or 371An update constitutes a non-trivial update to any documentation, translation or
451otherwise, completely written by the contributor and committed after review by 372otherwise, completely written or edited by the contributor and committed after
452any existing documentation developer. The period is fixed - increasing the 373review by any existing documentation developer.
453contributions does not decrease the period. Also, we don't average the
454contributions over time to make sure the contributor doesn't give a contribution
455burst and then waits until the Phase is over.
456</p>
457
458<p> 374</p>
459Without this phase we can not know if the contributor understands what it takes 375
460to be a documentation developer. The validation of this activity happens through
461bugzilla reports.
462</p> 376<p>
463
464<p>
465Any request for CVS access that does not allow a development activity as written
466down in the aforementioned table will not be taken into account.
467</p>
468
469<p>
470If you feel that you have shown sufficient amount of contributions, contact 377If you feel that you have shown sufficient amount of contributions, contact
471the Operational Manager of the Gentoo Documentation Project. He 378the project lead of the Gentoo Documentation Project who will review the
379contributions and the timeframe (or delegate this towards another GDP member).
472will ask you for your coordinates and other information and then arrange 380He will ask you for your coordinates and other information, and
473for the next phase to be started. 381then arrange for the next phase to be started.
474</p> 382</p>
475 383
476</body> 384</body>
477</section>
478<section> 385</section>
479<title>Phase 2: Read-Only CVS Access</title> 386<section>
387<title>Phase 2: Start the Recruitment Process</title>
480<body> 388<body>
481 389
482<p> 390<p>
483During phase 2, the recruitee is given read-only access to the Gentoo 391During this period, submitted patches are not edited by a documentation
484Documentation Repository, allowing him to generate commit-ready patches for the 392developer anymore, but are either committed as-is or refused. The recruit is
485tree. During this period, which is roughly the same as the aforementioned table,
486his patches are not edited by a documentation developer anymore, but are either
487committed as-is or refused. The recruitee is also assigned to a full-time
488documentation developer (the mentor) which will guide him through these last 393also assigned to a documentation developer (the mentor) which will guide him
489phases. 394through these last phases.
490</p> 395</p>
491 396
492<p> 397<p>
493The quality of the contributions are in this phase most important - every patch 398The quality of the contributions are in this phase most important - every patch
494that does not follow the Documentation Policy, Coding Style or other guideline 399that does not follow the Documentation Policy, Coding Style or other guideline
495that affects the document is refused. 400that affects the document is tackled by the recruit himself with help of the
496</p> 401mentor.
497
498<p> 402</p>
499During this period, you: 403
500</p> 404<p>
501 405During this period, the recruit: is advised to learn about Gentoo's inner workings.
502<ul>
503 <li>
504 are advised to learn about Gentoo's inner workings.
505 This is required as you will be asked later on to answer Gentoo's <uri 406This is required as he or she will be asked later on to answer Gentoo's <uri
506 link="/proj/en/devrel/quiz/staff-quiz.txt">Staffing Quiz</uri>. 407link="/proj/en/devrel/quiz/staff-quiz.txt">Staffing Quiz</uri>.
507 </li> 408</p>
508 <li> 409
509 will be asked to fill in the <uri 410<p>
411It is also recommended, but not automatically required, to fill in the <uri
510 link="/proj/en/gdp/doc/doc-quiz.xml">Gentoo Documentation Project 412link="/proj/en/gdp/doc/doc-quiz.xml">Gentoo Documentation Project Quiz</uri>.
511 Quiz</uri>. You need to succesfully pass this entire quiz (all questions) 413This will assist the recruit in learning more about how the Gentoo Documentation
512 before you can continue with the next Phase. 414Project documentation works. If at a later time the Gentoo Documentation Project
513 </li> 415lead feels that the recruit (or by then editor or author) shows insufficient
514</ul> 416knowledge on this, he might ask the recruit (or by then editor or author) to
417work on the quiz after all.
418</p>
515 419
516</body> 420</body>
517</section> 421</section>
518<section> 422<section>
519<title>Phase 3: Gentoo Recruitment</title> 423<title>Phase 3: Gentoo Recruitment</title>
520<body> 424<body>
521 425
522<p> 426<p>
523When Phase 2 is finished, the Operational Manager will contact <uri 427When Phase 2 is finished, the project lead will contact <uri
524link="/proj/en/devrel">Developer Relations</uri> and give a final "Go!" for the 428link="/proj/en/devrel/">Developer Relations</uri> and give a final "Go!" for the
525Gentoo recruitment process after which you will be given a Gentoo e-mail 429Gentoo recruitment process after which the recruit will be given access to the
526address and be appointed to one or more subprojects. 430necessary Gentoo infrastructural services (like the documentation repository).
431</p>
432
433</body>
434</section>
435<section>
436<title>Recruitment of Existing Gentoo Developers</title>
437<body>
438
439<p>
440If the recruit is already a Gentoo Developer, the same recruitment process is
441followed, but of course the staffing quiz is not necessary anymore. The <uri
442link="/proj/en/gdp/doc/doc-quiz.xml">Gentoo Documentation Project Quiz</uri> is
443still recommended.
527</p> 444</p>
528 445
529</body> 446</body>
530</section> 447</section>
531</chapter> 448</chapter>

Legend:
Removed from v.1.12  
changed lines
  Added in v.1.28

  ViewVC Help
Powered by ViewVC 1.1.20