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

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

  ViewVC Help
Powered by ViewVC 1.1.20