/[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.19
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.19 2005/11/26 13:18:07 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>
15<author title="Editor"> 14<author title="Editor">
16 <mail link="spyderous@gentoo.org">Donnie Berkholz</mail> 15 <mail link="spyderous@gentoo.org">Donnie Berkholz</mail>
17</author> 16</author>
18 17
19<!-- The content of this document is licensed under the CC-BY-SA license --> 18<!-- The content of this document is licensed under the CC-BY-SA license -->
20<!-- See http://creativecommons.org/licenses/by-sa/2.0 --> 19<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
21 20
22<abstract> 21<abstract>
23This document contains the Gentoo Documentation Policy, which is the 22This document contains the Gentoo Documentation Policy, which is the
24base document which all Gentoo Documentation developers and 23base document which all Gentoo Documentation developers and
25Contributers should know and exercise. 24Contributors should know and exercise.
26</abstract> 25</abstract>
27 26
28<license/> 27<license/>
29 28
30<version>3.11</version> 29<version>3.16</version>
31<date>2005-05-07</date> 30<date>2005-11-26</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>
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<p>
81The Gentoo Documentation Project is strategically lead by a top-level manager 79The Gentoo Documentation Project is strategically led by a top-level Manager
82as required by the <uri link="/doc/en/management-structure.xml">Gentoo 80as required by the <uri link="/doc/en/management-structure.xml">Gentoo
83Management Structure</uri>. This document also describes the responsibilities 81Management Structure</uri>. This document also describes the responsibilities
84of the strategic manager with respect to Gentoo Linux. 82of the Strategic Manager with respect to Gentoo Linux.
85</p>
86
87<p> 83</p>
84
85<p>
88For day-to-day managerial tasks the Gentoo Documentation Project has an 86For day-to-day managerial tasks, the Gentoo Documentation Project has an
89operational manager. This person keeps track of all documentation-related tasks 87Operational Manager. This person keeps track of all short-term tasks
90that are more short-term. The operational manager and strategic manager can be 88related to documentation. The Operational Manager and Strategic Manager can be
91one and the same if the strategic manager wishes so. 89one and the same if the Strategic Manager wishes so.
92</p> 90</p>
93 91
94<p> 92<p>
95Currently these positions are taken by the following people: 93Currently these positions are taken by the following people:
96</p> 94</p>
112 <ti><mail link="neysx@gentoo.org">neysx</mail></ti> 110 <ti><mail link="neysx@gentoo.org">neysx</mail></ti>
113</tr> 111</tr>
114</table> 112</table>
115 113
116<p> 114<p>
117Every subproject has a strategic manager of its own. he can have an operational 115Every subproject has a Strategic Manager of its own, and may have an
118manager if he deems appropriate. His responsibilities to the Gentoo 116Operational Manager if deemed appropriate. His responsibilities to the Gentoo
119Documentation Project are the same as are listed on the <uri 117Documentation Project (GDP) are listed in the <e>Manager responsibilities</e>
118section of the <uri
120link="/doc/en/management-structure.xml#doc_chap1_sect5">Gentoo Management 119link="/doc/en/management-structure.xml#doc_chap1_sect5">Gentoo Management
121Structure</uri>. 120Structure</uri> document.
122</p>
123
124<p> 121</p>
125The subprojects of the Gentoo Documentation Team together with their respective 122
126strategic managers are listed on the <uri link="/proj/en/gdp/">GDP
127Website</uri>.
128</p> 123<p>
129 124Every subproject of the Gentoo Documentation Team is listed on the
125<uri link="/proj/en/gdp/">GDP Webpage</uri>, along with their respective
126Strategic Managers.
130<p> 127</p>
128
129<p>
131The decision on adding subprojects is in hands of the strategic manager. 130The decision on adding a subproject is in the hands of the Strategic Manager.
132</p> 131</p>
133 132
134</body> 133</body>
135</section> 134</section>
136<section> 135<section>
153team about bugs regarding the Gentoo Documentation. You can add yourself by 152team about bugs regarding the Gentoo Documentation. You can add yourself by
154editing <path>/var/mail/alias/misc/docs-team</path> on dev.gentoo.org. 153editing <path>/var/mail/alias/misc/docs-team</path> on dev.gentoo.org.
155</p> 154</p>
156 155
157<p> 156<p>
158Every member of the Gentoo Documentation Team should be available at 157Members 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> 158<c>#gentoo-doc</c> on <uri link="http://www.freenode.net">irc.freenode.net</uri>
160whenever he is online. 159whenever they are online.
161</p>
162
163<p> 160</p>
161
162<p>
164Depending on his responsibilities, he can have limited CVS 163Depending 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 164access to <c>cvs.gentoo.org</c>. Full CVS access is restricted to Gentoo
166developers. Read-only CVS access can be given to recruitees. 165Developers. Read-only CVS access may be granted to recruits.
167</p> 166</p>
168 167
169</body> 168</body>
170</section> 169</section>
171<section> 170<section>
172<title>Documentation Translation Teams</title> 171<title>Documentation Translation Teams</title>
173<body> 172<body>
174 173
175<p> 174<p>
176Every language should be backed up by an official translation team. This 175Every 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 176team 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 177Translator</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 178<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. 179Translator</e> is in charge. If the <e>Follow-On</e> is unavailable, the
181</p> 180mentor(s) is/are in charge of the language.
182
183<p> 181</p>
184If a translated document is contributed, but the language in itself is 182
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> 183<p>
189 184If a translated document for an unsupported language is contributed, the Gentoo
185Documentation Team will not publish it officially. Such documents shall not be
186linked to the website until an official Translation Team of that language is
187formed.
190<p> 188</p>
189
190<p>
191When a language is officially supported, but the team doesn't have any 191When 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 192members willing to take on the responsibilities of the <e>Lead
193translator, all links to the documents will be removed from the site. 193Translator</e>, all links to the documents will be removed from the site.
194However, the documents will stay available in case the language becomes 194However, the documents will stay available in case the language becomes
195officially supported again. 195officially supported again.
196</p> 196</p>
197 197
198<p>
199For more information Gentoo document translations, please consult the
200<uri link="/proj/en/gdp/doc/translators-howto.xml">
201Translators Howto for Gentoo Documentation</uri> and the
202<uri link="/proj/en/gdp/international.xml">
203GDP Internationalisation Subproject</uri> page.
204</p>
205
198</body> 206</body>
199</section> 207</section>
200</chapter> 208</chapter>
201 209
202<chapter> 210<chapter>
206<body> 214<body>
207 215
208<p> 216<p>
209Every document published by the Gentoo Documentation Project must be 217Every document published by the Gentoo Documentation Project must be
210licensed by the <uri 218licensed by the <uri
211link="http://creativecommons.org/licenses/by-sa/2.0/">Creative Commons 219link="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons
212Attribution-ShareAlike License</uri>. 220Attribution-ShareAlike License</uri>.
213</p> 221</p>
214 222
215<p> 223<p>
216Every document must have the following tag inside its GuideXML 224Every document must have the following tag inside its GuideXML
217sourcecode between the <c>&lt;/abstract&gt;</c> and the <c>&lt;version&gt;</c> 225source code between the <c>&lt;/abstract&gt;</c> and the <c>&lt;version&gt;</c>
218tags: 226tags:
219</p> 227</p>
220 228
221<pre caption = "Licensing notice for the Gentoo Documentation"> 229<pre caption = "Licensing notice for the Gentoo Documentation">
222&lt;/abstract&gt; 230&lt;/abstract&gt;
223<i> 231<i>
224&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt; 232&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; 233&lt;!-- See http://creativecommons.org/licenses/by-sa/2.5 --&gt;
226&lt;license/&gt; 234&lt;license/&gt;
227</i> 235</i>
228&lt;version&gt;...&lt;/version&gt; 236&lt;version&gt;...&lt;/version&gt;
229</pre> 237</pre>
230 238
236 244
237<p> 245<p>
238Every bug reported on <uri link="http://bugs.gentoo.org">bugs.gentoo.org</uri> 246Every 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 247should 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 248in 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 249this 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 250<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 251applicable. 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 252higher priority and should be addressed ahead any other task the assignee
245is responsible of. 253is responsible for.
246</p> 254</p>
247 255
248<p> 256<p>
249Whenever a Gentoo Documentation Team member takes care of a bug, he or 257Whenever a Gentoo Documentation Team member takes care of a bug, he or
250she should assign the bug to herself/himself, but make sure that 258she should 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 259<c>docs-team@gentoo.org</c> is on the Cc-list. A bug may not be taken away from
252of the operational manager, a bug may not be taken away from another
253Gentoo Documentation Team member without their approval. 260another Gentoo Documentation Team member without their approval; unless consent
261has been received from the Operational Manager.
254</p> 262</p>
255 263
256</body> 264</body>
257</section> 265</section>
258<section> 266<section>
259<title>Document Development</title> 267<title>Document Development</title>
260<body> 268<body>
261 269
262<p> 270<p>
263Every document the Gentoo Documentation Team develops can be developed as the 271Every Gentoo Documentation Team may handle documentation development as it sees
264related parties see fit. However, when the document is finished, it should be 272fit. However, when the document is finished, it should be transformed into
265transformed into <uri link="/doc/en/xml-guide.xml">GuideXML</uri> and put 273<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 274Gentoo CVS infrastructure. It must also be registered in the
267<uri link="/proj/en/gdp/doc/metadoc-guide.xml">metadoc.xml</uri> file if 275<uri link="/proj/en/gdp/doc/metadoc-guide.xml">metadoc.xml</uri> file if
268applicable. 276applicable.
269</p> 277</p>
270 278
271<p> 279<p>
306<section> 314<section>
307<title>Reviewing and Committing</title> 315<title>Reviewing and Committing</title>
308<body> 316<body>
309 317
310<p> 318<p>
311To keep a high-pace development cycle of the documentation, technical or 319To maintain a high-paced documentation development cycle, technical or
312intrusive changes to documents can be propagated immediately to the document 320intrusive 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 321This 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 322are functional. If you are not absolutely confident (for instance because a
315it but you cannot verify yourself), have the change reviewed by a Gentoo 323user has told you how to fix it but you cannot verify yourself), have the
316Developer that can verify the change. 324changes reviewed by a Gentoo Developer that can verify the changes are apt.
317</p>
318
319<p> 325</p>
326
327<p>
320High volume, technical or intrusive changes must be accompanied by a bugreport 328High-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 329on <uri>http://bugs.gentoo.org</uri>. This bug number <e>must</e> be mentioned
322the CVS log to allow backtracing of changes. 330in the CVS log to allow backtracing of changes.
323</p>
324
325<p> 331</p>
326If a bugfix consists out of both content as internal coding changes, 332
327both changes must be committed separately so that translators can easily
328view the important changes (content) and ignore the coding changes.
329</p> 333<p>
330 334If a bugfix includes changes to content as well as internal coding changes,
335both changes must be committed separately. This allows translators to focus
336on the relevant changes regarding content and ignore the coding changes.
331<p> 337</p>
332In case of a translation, the lead translator of the language is 338
333responsible for the document. Only he may commit the document to CVS 339<p>
334unless he is currently "in training", in which case his or her 340If the document in question is a translation, the <e>Lead Translator</e> of the
335mentor should commit it. 341affected language is responsible for the document. Only the
342<e>Lead Translator</e> may commit the document to the CVS repository. However,
343if the <e>Lead Translator</e> is currently "in training", the trainee's mentor
344should commit the changes.
336</p> 345</p>
337 346
338</body> 347</body>
339</section> 348</section>
340<section> 349<section>
341<title>Sanctions</title> 350<title>Sanctions</title>
342<body> 351<body>
343 352
344<p> 353<p>
345Although this has never been necessary, it is still important to list this in 354Malicious conduct by developers has never been an issue. However, it should be
346the policy - even though it is hateful. Anyway, documentation developers that 355noted that documentation developers that misuse their position by
347misuse their position by
348</p> 356</p>
349 357
350<ul> 358<ul>
351 <li>deliberately providing wrong information to users or developers</li> 359 <li>deliberately providing wrong information to users or developers</li>
352 <li>deliberately writing flawed documentation</li> 360 <li>deliberately writing flawed documentation</li>
354 <li> 362 <li>
355 deliberately go against the decisions made policy-wise or through a 363 deliberately go against the decisions made policy-wise or through a
356 consensus-model on the Gentoo Documentation mailinglist 364 consensus-model on the Gentoo Documentation mailinglist
357 </li> 365 </li>
358 <li> 366 <li>
359 not performing at all for a long time without informing the GDP and without 367 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 368 replying to the Operational Manager's request for a status update
361 </li> 369 </li>
362</ul> 370</ul>
363 371
364<p> 372<p>
365will be reported to the <uri link="/proj/en/devrel/">Gentoo Developer 373will be reported to the <uri link="/proj/en/devrel/">Gentoo Developer
369</body> 377</body>
370</section> 378</section>
371</chapter> 379</chapter>
372 380
373<chapter> 381<chapter>
374<title>Documentation Team Recruitement</title> 382<title>Documentation Team Recruitment</title>
375<section> 383<section>
376<title>Contributors, Authors, Translators</title> 384<title>Contributors, Authors, Translators</title>
377<body> 385<body>
378 386
379<p> 387<p>
380Everyone interested in contributing documentation, editing existing 388Everyone interested in contributing documentation, editing existing
381documentation, writing new documentation or translating documentation is 389documentation, writing new documentation or translating documentation is
382welcome to join the team. There are no rules or strings attached to 390welcome to join the team. There are no rules or strings attached to
383this. Just make sure you are subscribed to <c>gentoo-doc@gentoo.org</c> 391this. Just make sure you are subscribed to <c>gentoo-doc@gentoo.org</c>,
384and you have fully read this policy and understand it. 392and you have fully read this policy and understand it.
385</p> 393</p>
386 394
387</body> 395</body>
388</section> 396</section>
391<body> 399<body>
392 400
393<p> 401<p>
394The Documentation Project has a strict recruitment process outlined below. 402The Documentation Project has a strict recruitment process outlined below.
395This process can not be deviated from in any circumstance. We have opted for 403This 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 404this recruitment process to assure ourselves that the recruit is well informed
397about the Gentoo Documentation Policy and the Gentoo Coding Style. It has proven 405about 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 406to be quite effective even though many contributors see it as a too large burden
399to cross. 407to cross.
400</p> 408</p>
401 409
450An update constitutes a non-trivial update to any documentation, translation or 458An update constitutes a non-trivial update to any documentation, translation or
451otherwise, completely written by the contributor and committed after review by 459otherwise, completely written by the contributor and committed after review by
452any existing documentation developer. The period is fixed - increasing the 460any existing documentation developer. The period is fixed - increasing the
453contributions does not decrease the period. Also, we don't average the 461contributions does not decrease the period. Also, we don't average the
454contributions over time to make sure the contributor doesn't give a contribution 462contributions over time to make sure the contributor doesn't give a contribution
455burst and then waits until the Phase is over. 463burst, and then waits until the Phase is over.
456</p> 464</p>
457 465
458<p> 466<p>
459Without this phase we can not know if the contributor understands what it takes 467Without this phase we can not know if the contributor understands what it takes
460to be a documentation developer. The validation of this activity happens through 468to be a documentation developer. The validation of this activity happens through
467</p> 475</p>
468 476
469<p> 477<p>
470If you feel that you have shown sufficient amount of contributions, contact 478If you feel that you have shown sufficient amount of contributions, contact
471the Operational Manager of the Gentoo Documentation Project. He 479the Operational Manager of the Gentoo Documentation Project. He
472will ask you for your coordinates and other information and then arrange 480will ask you for your coordinates and other information, and then arrange
473for the next phase to be started. 481for the next phase to be started.
474</p> 482</p>
475 483
476</body> 484</body>
477</section> 485</section>
478<section> 486<section>
479<title>Phase 2: Read-Only CVS Access</title> 487<title>Phase 2: Read-Only CVS Access</title>
480<body> 488<body>
481 489
482<p> 490<p>
483During phase 2, the recruitee is given read-only access to the Gentoo 491During phase 2, the recruit is given read-only access to the Gentoo
484Documentation Repository, allowing him to generate commit-ready patches for the 492Documentation Repository, allowing him to generate commit-ready patches for
485tree. During this period, which is roughly the same as the aforementioned table, 493the tree. During this period, which is roughly the same as the aforementioned
486his patches are not edited by a documentation developer anymore, but are either 494table, his patches are not edited by a documentation developer anymore, but
487committed as-is or refused. The recruitee is also assigned to a full-time 495are either committed as-is or refused. The recruit is also assigned to a
488documentation developer (the mentor) which will guide him through these last 496full-time documentation developer (the mentor) which will guide him through
489phases. 497these last phases.
490</p> 498</p>
491 499
492<p> 500<p>
493The quality of the contributions are in this phase most important - every patch 501The quality of the contributions are in this phase most important - every patch
494that does not follow the Documentation Policy, Coding Style or other guideline 502that does not follow the Documentation Policy, Coding Style or other guideline
506 link="/proj/en/devrel/quiz/staff-quiz.txt">Staffing Quiz</uri>. 514 link="/proj/en/devrel/quiz/staff-quiz.txt">Staffing Quiz</uri>.
507 </li> 515 </li>
508 <li> 516 <li>
509 will be asked to fill in the <uri 517 will be asked to fill in the <uri
510 link="/proj/en/gdp/doc/doc-quiz.xml">Gentoo Documentation Project 518 link="/proj/en/gdp/doc/doc-quiz.xml">Gentoo Documentation Project
511 Quiz</uri>. You need to succesfully pass this entire quiz (all questions) 519 Quiz</uri>. You need to successfully pass this entire quiz (all questions)
512 before you can continue with the next Phase. 520 before you can continue with the next Phase.
513 </li> 521 </li>
514</ul> 522</ul>
515 523
516</body> 524</body>

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

  ViewVC Help
Powered by ViewVC 1.1.20