| 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.13 2005/06/02 16:44:16 swift Exp $ --> |
| 3 | |
3 | |
| 4 | <!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> |
4 | <!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> |
| 5 | |
5 | |
| 6 | <guide link="doc-policy.xml"> |
6 | <guide link="doc-policy.xml"> |
| 7 | |
7 | |
| … | |
… | |
| 38 | |
38 | |
| 39 | <p> |
39 | <p> |
| 40 | The Gentoo Linux Documentation team aspires to create exceptionally |
40 | The Gentoo Linux Documentation team aspires to create exceptionally |
| 41 | professional documentation that is immediately clear and concise to the |
41 | professional documentation that is immediately clear and concise to the |
| 42 | end user. In order to fulfill this goal, we have very specific rules and |
42 | end user. In order to fulfill this goal, we have very specific rules and |
| 43 | guidelines that <e>all</e> documentation must go through before it is |
43 | guidelines that <e>all</e> documentation must go through prior to |
| 44 | published on our website, or otherwise. |
44 | dissemination on our website, or otherwise. |
| 45 | </p> |
45 | </p> |
| 46 | |
46 | |
| 47 | </body> |
47 | </body> |
| 48 | </section> |
48 | </section> |
| 49 | <section> |
49 | <section> |
| 50 | <title>Covered Topics</title> |
50 | <title>Covered Topics</title> |
| 51 | <body> |
51 | <body> |
| 52 | |
52 | |
| 53 | <p> |
53 | <p> |
| 54 | This policy will cover these topics: |
54 | This policy will cover the following topics: |
| 55 | </p> |
55 | </p> |
| 56 | |
56 | |
| 57 | <ul> |
57 | <ul> |
| 58 | <li>Documentation Project Team Organization</li> |
58 | <li>Documentation Project Team Organization</li> |
| 59 | <li>Documentation Guidelines</li> |
59 | <li>Documentation Guidelines</li> |
| 60 | <li>Documentation Team Recruitement</li> |
60 | <li>Documentation Team Recruitment</li> |
| 61 | </ul> |
61 | </ul> |
| 62 | |
62 | |
| 63 | </body> |
63 | </body> |
| 64 | </section> |
64 | </section> |
| 65 | </chapter> |
65 | </chapter> |
| … | |
… | |
| 76 | represents an active development team of a Gentoo Documentation |
76 | represents an active development team of a Gentoo Documentation |
| 77 | Subproject. |
77 | Subproject. |
| 78 | </p> |
78 | </p> |
| 79 | |
79 | |
| 80 | <p> |
80 | <p> |
| 81 | The Gentoo Documentation Project is strategically lead by a top-level manager |
81 | The Gentoo Documentation Project is strategically led by a top-level manager |
| 82 | as required by the <uri link="/doc/en/management-structure.xml">Gentoo |
82 | as required by the <uri link="/doc/en/management-structure.xml">Gentoo |
| 83 | Management Structure</uri>. This document also describes the responsibilities |
83 | Management Structure</uri>. This document also describes the responsibilities |
| 84 | of the strategic manager with respect to Gentoo Linux. |
84 | of the strategic manager with respect to Gentoo Linux. |
| 85 | </p> |
85 | </p> |
| 86 | |
86 | |
| 87 | <p> |
87 | <p> |
| 88 | For day-to-day managerial tasks the Gentoo Documentation Project has an |
88 | For day-to-day managerial tasks, the Gentoo Documentation Project has an |
| 89 | operational manager. This person keeps track of all documentation-related tasks |
89 | operational manager. This person keeps track of all documentation-related tasks |
| 90 | that are more short-term. The operational manager and strategic manager can be |
90 | that are more short-term. The operational manager and strategic manager can be |
| 91 | one and the same if the strategic manager wishes so. |
91 | one and the same if the strategic manager wishes so. |
| 92 | </p> |
92 | </p> |
| 93 | |
93 | |
| … | |
… | |
| 112 | <ti><mail link="neysx@gentoo.org">neysx</mail></ti> |
112 | <ti><mail link="neysx@gentoo.org">neysx</mail></ti> |
| 113 | </tr> |
113 | </tr> |
| 114 | </table> |
114 | </table> |
| 115 | |
115 | |
| 116 | <p> |
116 | <p> |
| 117 | Every subproject has a strategic manager of its own. he can have an operational |
117 | Every subproject has a strategic manager of its own and may have an |
| 118 | manager if he deems appropriate. His responsibilities to the Gentoo |
118 | Operational Manager if deemed appropriate. His responsibilities to the Gentoo |
| 119 | Documentation Project are the same as are listed on the <uri |
119 | Documentation Project are the same as are listed on the <uri |
| 120 | link="/doc/en/management-structure.xml#doc_chap1_sect5">Gentoo Management |
120 | link="/doc/en/management-structure.xml#doc_chap1_sect5">Gentoo Management |
| 121 | Structure</uri>. |
121 | Structure</uri>. |
| 122 | </p> |
122 | </p> |
| 123 | |
123 | |
| … | |
… | |
| 161 | </p> |
161 | </p> |
| 162 | |
162 | |
| 163 | <p> |
163 | <p> |
| 164 | Depending on his responsibilities, he can have limited CVS |
164 | Depending on his responsibilities, he can have limited CVS |
| 165 | access to <c>cvs.gentoo.org</c>. Full CVS access can only be given to Gentoo |
165 | access to <c>cvs.gentoo.org</c>. Full CVS access can only be given to Gentoo |
| 166 | developers. Read-only CVS access can be given to recruitees. |
166 | developers. Read-only CVS access can be given to recruits. |
| 167 | </p> |
167 | </p> |
| 168 | |
168 | |
| 169 | </body> |
169 | </body> |
| 170 | </section> |
170 | </section> |
| 171 | <section> |
171 | <section> |
| … | |
… | |
| 212 | Attribution-ShareAlike License</uri>. |
212 | Attribution-ShareAlike License</uri>. |
| 213 | </p> |
213 | </p> |
| 214 | |
214 | |
| 215 | <p> |
215 | <p> |
| 216 | Every document must have the following tag inside its GuideXML |
216 | Every document must have the following tag inside its GuideXML |
| 217 | sourcecode between the <c></abstract></c> and the <c><version></c> |
217 | source code between the <c></abstract></c> and the <c><version></c> |
| 218 | tags: |
218 | tags: |
| 219 | </p> |
219 | </p> |
| 220 | |
220 | |
| 221 | <pre caption = "Licensing notice for the Gentoo Documentation"> |
221 | <pre caption = "Licensing notice for the Gentoo Documentation"> |
| 222 | </abstract> |
222 | </abstract> |
| … | |
… | |
| 238 | Every bug reported on <uri link="http://bugs.gentoo.org">bugs.gentoo.org</uri> |
238 | Every bug reported on <uri link="http://bugs.gentoo.org">bugs.gentoo.org</uri> |
| 239 | should be handled as fast as possible. If a bug cannot be handled |
239 | should be handled as fast as possible. If a bug cannot be handled |
| 240 | in a timely fashion, the reporter of that bug should be informed about |
240 | in a timely fashion, the reporter of that bug should be informed about |
| 241 | this using a comment on the bug and the bug should be registered in the |
241 | this 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 |
242 | <uri link="/proj/en/gdp/doc/metadoc-guide.xml">metadoc.xml</uri> file, if |
| 243 | applicable. The tactical or operational manager can decide that a bug has a |
243 | applicable. The tactical or operational manager may decide that a bug has a |
| 244 | higher priority and should be handled first before any other task the assingee |
244 | higher priority and should be addressed ahead any other task the assingee |
| 245 | is responsible of. |
245 | is responsible of. |
| 246 | </p> |
246 | </p> |
| 247 | |
247 | |
| 248 | <p> |
248 | <p> |
| 249 | Whenever a Gentoo Documentation Team member takes care of a bug, he or |
249 | Whenever a Gentoo Documentation Team member takes care of a bug, he or |
| … | |
… | |
| 316 | Developer that can verify the change. |
316 | Developer that can verify the change. |
| 317 | </p> |
317 | </p> |
| 318 | |
318 | |
| 319 | <p> |
319 | <p> |
| 320 | High volume, technical or intrusive changes must be accompanied by a bugreport |
320 | High volume, technical or intrusive changes must be accompanied by a bugreport |
| 321 | on <uri>http://bugs.gentoo.org</uri>. This bugnumber <e>must</e> be mentioned in |
321 | on <uri>http://bugs.gentoo.org</uri>. This bug number <e>must</e> be mentioned |
| 322 | the CVS log to allow backtracing of changes. |
322 | in the CVS log to allow backtracing of changes. |
| 323 | </p> |
323 | </p> |
| 324 | |
324 | |
| 325 | <p> |
325 | <p> |
| 326 | If a bugfix consists out of both content as internal coding changes, |
326 | If a bugfix consists out of both content as internal coding changes, |
| 327 | both changes must be committed separately so that translators can easily |
327 | both changes must be committed separately so that translators can easily |
| … | |
… | |
| 391 | <body> |
391 | <body> |
| 392 | |
392 | |
| 393 | <p> |
393 | <p> |
| 394 | The Documentation Project has a strict recruitment process outlined below. |
394 | The Documentation Project has a strict recruitment process outlined below. |
| 395 | This process can not be deviated from in any circumstance. We have opted for |
395 | This process can not be deviated from in any circumstance. We have opted for |
| 396 | this recruitment process to assure ourselves that the recruitee is well informed |
396 | this recruitment process to assure ourselves that the recruit is well informed |
| 397 | about the Gentoo Documentation Policy and the Gentoo Coding Style. It has proven |
397 | about the Gentoo Documentation Policy and the Gentoo Coding Style. It has proven |
| 398 | to be quite effective even though many contributors see it as a too large burden |
398 | to be quite effective even though many contributors see it as a too large burden |
| 399 | to cross. |
399 | to cross. |
| 400 | </p> |
400 | </p> |
| 401 | |
401 | |
| … | |
… | |
| 482 | <p> |
482 | <p> |
| 483 | During phase 2, the recruitee is given read-only access to the Gentoo |
483 | During phase 2, the recruitee is given read-only access to the Gentoo |
| 484 | Documentation Repository, allowing him to generate commit-ready patches for the |
484 | Documentation Repository, allowing him to generate commit-ready patches for the |
| 485 | tree. During this period, which is roughly the same as the aforementioned table, |
485 | tree. During this period, which is roughly the same as the aforementioned table, |
| 486 | his patches are not edited by a documentation developer anymore, but are either |
486 | his patches are not edited by a documentation developer anymore, but are either |
| 487 | committed as-is or refused. The recruitee is also assigned to a full-time |
487 | committed as-is or refused. The recruit is also assigned to a full-time |
| 488 | documentation developer (the mentor) which will guide him through these last |
488 | documentation developer (the mentor) which will guide him through these last |
| 489 | phases. |
489 | phases. |
| 490 | </p> |
490 | </p> |
| 491 | |
491 | |
| 492 | <p> |
492 | <p> |
| … | |
… | |
| 506 | link="/proj/en/devrel/quiz/staff-quiz.txt">Staffing Quiz</uri>. |
506 | link="/proj/en/devrel/quiz/staff-quiz.txt">Staffing Quiz</uri>. |
| 507 | </li> |
507 | </li> |
| 508 | <li> |
508 | <li> |
| 509 | will be asked to fill in the <uri |
509 | will be asked to fill in the <uri |
| 510 | link="/proj/en/gdp/doc/doc-quiz.xml">Gentoo Documentation Project |
510 | link="/proj/en/gdp/doc/doc-quiz.xml">Gentoo Documentation Project |
| 511 | Quiz</uri>. You need to succesfully pass this entire quiz (all questions) |
511 | Quiz</uri>. You need to successfully pass this entire quiz (all questions) |
| 512 | before you can continue with the next Phase. |
512 | before you can continue with the next Phase. |
| 513 | </li> |
513 | </li> |
| 514 | </ul> |
514 | </ul> |
| 515 | |
515 | |
| 516 | </body> |
516 | </body> |
Parent Directory
| 
Revision Log
| 
Patch