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

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

  ViewVC Help
Powered by ViewVC 1.1.20