/[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.15 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.15 2005/06/02 16:58:03 swift 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.13</version> 29<version>3.16</version>
31<date>2005-06-02</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>
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 prior to 42guidelines that <e>all</e> documentation must go through prior to
44dissemination 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>
111 <ti><mail link="neysx@gentoo.org">neysx</mail></ti> 110 <ti><mail link="neysx@gentoo.org">neysx</mail></ti>
112</tr> 111</tr>
113</table> 112</table>
114 113
115<p> 114<p>
116Every subproject has a Strategic Manager of its own and may have an 115Every subproject has a Strategic Manager of its own, and may have an
117Operational Manager if deemed appropriate. His responsibilities to the Gentoo 116Operational Manager if deemed appropriate. His responsibilities to the Gentoo
118Documentation Project (GDP) are listed in the <e>Manager responsibilities</e> 117Documentation Project (GDP) are listed in the <e>Manager responsibilities</e>
119section of the <uri 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> document. 120Structure</uri> document.
215<body> 214<body>
216 215
217<p> 216<p>
218Every document published by the Gentoo Documentation Project must be 217Every document published by the Gentoo Documentation Project must be
219licensed by the <uri 218licensed by the <uri
220link="http://creativecommons.org/licenses/by-sa/2.0/">Creative Commons 219link="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons
221Attribution-ShareAlike License</uri>. 220Attribution-ShareAlike License</uri>.
222</p> 221</p>
223 222
224<p> 223<p>
225Every document must have the following tag inside its GuideXML 224Every document must have the following tag inside its GuideXML
229 228
230<pre caption = "Licensing notice for the Gentoo Documentation"> 229<pre caption = "Licensing notice for the Gentoo Documentation">
231&lt;/abstract&gt; 230&lt;/abstract&gt;
232<i> 231<i>
233&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;
234&lt;!-- See http://creativecommons.org/licenses/by-sa/2.0 --&gt; 233&lt;!-- See http://creativecommons.org/licenses/by-sa/2.5 --&gt;
235&lt;license/&gt; 234&lt;license/&gt;
236</i> 235</i>
237&lt;version&gt;...&lt;/version&gt; 236&lt;version&gt;...&lt;/version&gt;
238</pre> 237</pre>
239 238
245 244
246<p> 245<p>
247Every 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>
248should 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
249in 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
250this 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
251<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
252applicable. The Strategic or Operational Manager may decide that a bug has a 251applicable. The Strategic or Operational Manager may decide that a bug has a
253higher priority and should be addressed ahead any other task the assignee 252higher priority and should be addressed ahead any other task the assignee
254is responsible for. 253is responsible for.
255</p> 254</p>
363 <li> 362 <li>
364 deliberately go against the decisions made policy-wise or through a 363 deliberately go against the decisions made policy-wise or through a
365 consensus-model on the Gentoo Documentation mailinglist 364 consensus-model on the Gentoo Documentation mailinglist
366 </li> 365 </li>
367 <li> 366 <li>
368 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
369 replying to the Operational Manager's request for a status update 368 replying to the Operational Manager's request for a status update
370 </li> 369 </li>
371</ul> 370</ul>
372 371
373<p> 372<p>
378</body> 377</body>
379</section> 378</section>
380</chapter> 379</chapter>
381 380
382<chapter> 381<chapter>
383<title>Documentation Team Recruitement</title> 382<title>Documentation Team Recruitment</title>
384<section> 383<section>
385<title>Contributors, Authors, Translators</title> 384<title>Contributors, Authors, Translators</title>
386<body> 385<body>
387 386
388<p> 387<p>
389Everyone interested in contributing documentation, editing existing 388Everyone interested in contributing documentation, editing existing
390documentation, writing new documentation or translating documentation is 389documentation, writing new documentation or translating documentation is
391welcome 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
392this. 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>,
393and you have fully read this policy and understand it. 392and you have fully read this policy and understand it.
394</p> 393</p>
395 394
396</body> 395</body>
397</section> 396</section>
459An update constitutes a non-trivial update to any documentation, translation or 458An update constitutes a non-trivial update to any documentation, translation or
460otherwise, completely written by the contributor and committed after review by 459otherwise, completely written by the contributor and committed after review by
461any existing documentation developer. The period is fixed - increasing the 460any existing documentation developer. The period is fixed - increasing the
462contributions does not decrease the period. Also, we don't average the 461contributions does not decrease the period. Also, we don't average the
463contributions 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
464burst and then waits until the Phase is over. 463burst, and then waits until the Phase is over.
465</p> 464</p>
466 465
467<p> 466<p>
468Without 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
469to be a documentation developer. The validation of this activity happens through 468to be a documentation developer. The validation of this activity happens through
476</p> 475</p>
477 476
478<p> 477<p>
479If you feel that you have shown sufficient amount of contributions, contact 478If you feel that you have shown sufficient amount of contributions, contact
480the Operational Manager of the Gentoo Documentation Project. He 479the Operational Manager of the Gentoo Documentation Project. He
481will ask you for your coordinates and other information and then arrange 480will ask you for your coordinates and other information, and then arrange
482for the next phase to be started. 481for the next phase to be started.
483</p> 482</p>
484 483
485</body> 484</body>
486</section> 485</section>

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

  ViewVC Help
Powered by ViewVC 1.1.20