/[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.10 Revision 1.11
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.10 2005/01/20 11:14:51 neysx Exp $ --> 2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-policy.xml,v 1.11 2005/05/07 19:06:52 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
25Contributers should know and exercise. 25Contributers should know and exercise.
26</abstract> 26</abstract>
27 27
28<license/> 28<license/>
29 29
30<version>3.10</version> 30<version>3.11</version>
31<date>2005-01-08</date> 31<date>2005-05-07</date>
32 32
33<chapter> 33<chapter>
34<title>Introduction</title> 34<title>Introduction</title>
35<section> 35<section>
36<title>Introduction</title> 36<title>Introduction</title>
144documentation-related issues. This mailing list is open to all interested 144documentation-related issues. This mailing list is open to all interested
145parties, developer or not. 145parties, developer or not.
146</p> 146</p>
147 147
148<p> 148<p>
149Every member of the Gentoo Documentation Project must be subscribed to the 149Every 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 150<mail link="docs-team@gentoo.org">docs-team@gentoo.org</mail> alias. This
151alias 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 152link="http://bugs.gentoo.org">bugs.gentoo.org</uri> to inform the documentation
153team about bugs regarding the Gentoo Documentation. 153team about bugs regarding the Gentoo Documentation. You can add yourself by
154editing <path>/var/mail/alias/misc/docs-team</path> on dev.gentoo.org.
154</p> 155</p>
155 156
156<p> 157<p>
157Every member of the Gentoo Documentation Team should be available at 158Every member of the Gentoo Documentation Team should be available at
158<c>#gentoo-doc</c> on <uri link="http://www.freenode.net">irc.freenode.net</uri> 159<c>#gentoo-doc</c> on <uri link="http://www.freenode.net">irc.freenode.net</uri>
159whenever he is online. 160whenever he is online.
160</p> 161</p>
161 162
162<p> 163<p>
163Depending on his responsibilities, he can have limited CVS 164Depending on his responsibilities, he can have limited CVS
164access to <c>cvs.gentoo.org</c>. CVS access can only be given to Gentoo 165access to <c>cvs.gentoo.org</c>. Full CVS access can only be given to Gentoo
165developers. 166developers. Read-only CVS access can be given to recruitees.
166</p> 167</p>
167 168
168</body> 169</body>
169</section> 170</section>
170<section> 171<section>
384</p> 385</p>
385 386
386</body> 387</body>
387</section> 388</section>
388<section> 389<section>
389<title>Gentoo Documentation Developer</title> 390<title>Recruitment Process</title>
391<body>
392
393<p>
394The Documentation Project has a strict recruitment process outlined below.
395This 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
397about 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
399to cross.
400</p>
401
402<p>
403This 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
405certain document or range of documents is granted by a simple request to the
406Operational Manager or Project Lead.
407</p>
408
390<body> 409</body>
410</section>
411<section>
412<title>Phase 1: Contributions</title>
413<body>
391 414
392<p>
393As a Gentoo documentation developer should know everything in the <uri
394link="/proj/en/devrel/handbook/handbook.xml?part=3&amp;chap=1">Gentoo Ebuild
395Policy</uri> even though you're not submitting ebuilds. This is all needed to
396ensure our userbase that no Gentoo developer gives wrong information about
397critical things.
398</p> 415<p>
399 416No recruitment process starts without investigating the contributions done
417already to the Gentoo Documentation Project. The number of contributions must be
418large 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
420time-consuming position and pressure the application involves.
400<p> 421</p>
422
423<p>
424The number of contributions and period over which the contributions should be
425made depends on the position which the contributor solicits for. Although it is
426difficult to write down these measurements in numbers, the following table
427should give a general overview. Final decision however lays in the hands of the
428Operational Manager.
429</p>
430
431<table>
432<tr>
433 <th>Position</th>
434 <th>Minimal Activity</th>
435 <th>Minimal Period</th>
436</tr>
437<tr>
438 <ti>Full-time Developer</ti>
439 <ti>2 updates per week</ti>
440 <ti>1 months</ti>
441</tr>
442<tr>
443 <ti>Part-time Developer</ti>
444 <ti>4 updates per month</ti>
445 <ti>1 months</ti>
446</tr>
447</table>
448
449<p>
450An update constitutes a non-trivial update to any documentation, translation or
451otherwise, completely written by the contributor and committed after review by
452any existing documentation developer. The period is fixed - increasing the
453contributions does not decrease the period. Also, we don't average the
454contributions over time to make sure the contributor doesn't give a contribution
455burst and then waits until the Phase is over.
456</p>
457
458<p>
459Without 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
461bugzilla reports.
462</p>
463
464<p>
465Any request for CVS access that does not allow a development activity as written
466down in the abovementioned table will not be taken into account.
467</p>
468
469<p>
470If you feel that you have shown sufficient amount of contributions, contact
401Contact the operational manager of the Gentoo Documentation Project. He 471the Operational Manager of the Gentoo Documentation Project. He
402will ask you for your coordinates and other information and then arrange 472will ask you for your coordinates and other information and then arrange
403a mentor for you who will guide you through the first days or weeks as 473for the next phase to be started.
404developer.
405</p>
406
407<p> 474</p>
408You will be given a Gentoo e-mail address and be appointed to one or
409more subprojects. During the initial days or weeks, you should ask your
410mentor as much as possible, preferably have him double-check everything
411you do. If your function requires CVS access, you will only receive it
412when your mentor deems it appropriate. Until then, your mentor is in
413charge of the CVS commits.
414</p>
415 475
416</body> 476</body>
417</section>
418<section> 477</section>
419<title>(Follow-Up) Lead Translator</title> 478<section>
479<title>Phase 2: Read-Only CVS Access</title>
480<body>
481
482<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 abovementioned table,
486his patches are not edited by a documentation developer anymore, but are either
487committed as-is or refused. The recruitee is also assigned to a full-time
488documentation developer (the mentor) which will guide him through these last
489phases.
490</p>
491
492<p>
493The quality of the contributions are in this phase most important - every patch
494that does not follow the Documentation Policy, Coding Style or other guideline
495that affects the document is refused.
496</p>
497
498<p>
499During this period, you:
500</p>
501
502<ul>
503 <li>
504 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
506 link="/proj/en/devrel/quiz/staff-quiz.txt">Staffing Quiz</uri>.
507 </li>
508 <li>
509 will be asked to fill in the <uri
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)
512 before you can continue with the next Phase.
513 </li>
514</ul>
515
420<body> 516</body>
517</section>
518<section>
519<title>Phase 3: Gentoo Recruitment</title>
520<body>
421 521
422<p>
423Becoming a (follow-up) lead translator shouldn't be held lightly. You are
424responsible for every translated document and final reviewing. The lead
425translator will make certain that the translated documents are
426grammatically and syntactically perfect.
427</p> 522<p>
428 523When Phase 2 is finished, the Operational Manager will contact <uri
429<p> 524link="/proj/en/devrel">Developer Relations</uri> and give a final "Go!" for the
430In order to become a Gentoo (follow-up) lead translator you must be a Gentoo 525Gentoo recruitment process after which you will be given a Gentoo e-mail
431developer. 526address and be appointed to one or more subprojects.
432</p>
433
434<p>
435During your "training" period you are a (follow-up) lead translator and
436should act upon it. All guidelines regarding (follow-up) lead translators
437apply.
438</p> 527</p>
439 528
440</body> 529</body>
441</section> 530</section>
442</chapter> 531</chapter>

Legend:
Removed from v.1.10  
changed lines
  Added in v.1.11

  ViewVC Help
Powered by ViewVC 1.1.20