/[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.22 Revision 1.23
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.22 2006/09/28 13:21:22 neysx Exp $ --> 2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-policy.xml,v 1.23 2007/03/05 12:57:48 neysx Exp $ -->
3<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> 3<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
4 4
5<guide link="doc-policy.xml"> 5<guide link="doc-policy.xml">
6 6
7<title>Gentoo Linux Documentation Policy</title> 7<title>Gentoo Linux Documentation Policy</title>
8<author title="Author"> 8
9<!-- <mail link="zhen@gentoo.org">-->John P. Davis
10</author>
11<author title="Author"> 9<author title="Author">
12 <mail link="neysx@gentoo.org">Xavier Neys</mail> 10 <mail link="neysx@gentoo.org">Xavier Neys</mail>
13</author> 11</author>
12<author title="Author">John P. Davis</author>
14<author title="Author"> 13<author title="Author">
15 <mail link="swift@gentoo.org">Sven Vermeulen</mail> 14 <mail link="swift@gentoo.org">Sven Vermeulen</mail>
16</author> 15</author>
17<author title="Editor"> 16<author title="Editor">
18 <mail link="dberkholz@gentoo.org">Donnie Berkholz</mail> 17 <mail link="dberkholz@gentoo.org">Donnie Berkholz</mail>
27Contributors should know and exercise. 26Contributors should know and exercise.
28</abstract> 27</abstract>
29 28
30<license/> 29<license/>
31 30
32<version>3.18</version> 31<version>4</version>
33<date>2006-09-27</date> 32<date>2007-02-26</date>
34 33
35<chapter> 34<chapter>
36<title>Introduction</title> 35<title>Introduction</title>
37<section> 36<section>
38<title>Introduction</title> 37<title>Introduction</title>
114 <ti>Xavier Neys</ti> 113 <ti>Xavier Neys</ti>
115 <ti><mail link="neysx@gentoo.org">neysx</mail></ti> 114 <ti><mail link="neysx@gentoo.org">neysx</mail></ti>
116</tr> 115</tr>
117</table> 116</table>
118 117
118<!--
119<p> 119<p>
120Every subproject has a Strategic Manager of its own, and may have an 120Every subproject has a Strategic Manager of its own, and may have an
121Operational Manager if deemed appropriate. His responsibilities to the Gentoo 121Operational Manager if deemed appropriate. His responsibilities to the Gentoo
122Documentation Project (GDP) are listed in the <e>Manager responsibilities</e> 122Documentation Project (GDP) are listed in the <e>Manager responsibilities</e>
123section of the <uri 123section of the <uri
124link="/doc/en/management-structure.xml#doc_chap1_sect5">Gentoo Management 124link="/doc/en/management-structure.xml#doc_chap1_sect5">Gentoo Management
125Structure</uri> document. 125Structure</uri> document.
126</p> 126</p>
127-->
127 128
128<p> 129<p>
129Every subproject of the Gentoo Documentation Team is listed on the 130Every subproject of the Gentoo Documentation Team is listed on the
130<uri link="/proj/en/gdp/">GDP Webpage</uri>, along with their respective 131<uri link="/proj/en/gdp/">GDP Webpage</uri>, along with their respective
131Strategic Managers. 132Strategic Managers.
141<title>Documentation Project Team Members</title> 142<title>Documentation Project Team Members</title>
142<body> 143<body>
143 144
144<p> 145<p>
145Every member of the Gentoo Documentation Project must be subscribed to 146Every member of the Gentoo Documentation Project must be subscribed to
146the <mail link="gentoo-doc-subscribe@gentoo.org">gentoo-doc@gentoo.org</mail> 147the <mail link="gentoo-doc+subscribe@gentoo.org">gentoo-doc@gentoo.org</mail>
147mailing list. This mailing list will be used to discuss all 148mailing list. This mailing list will be used to discuss all
148documentation-related issues. This mailing list is open to all interested 149documentation-related issues. This mailing list is open to all interested
149parties, developer or not. 150parties, developer or not.
150</p> 151</p>
151 152
152<p> 153<p>
153Every member of the Gentoo Documentation Project must be part of the 154Every member of the Gentoo Documentation Project must be part of the
154<mail link="docs-team@gentoo.org">docs-team@gentoo.org</mail> alias. This 155<mail>docs-team@gentoo.org</mail> alias. This alias is <e>only</e> used by <uri
155alias is <e>only</e> used by <uri
156link="http://bugs.gentoo.org">bugs.gentoo.org</uri> to inform the documentation 156link="http://bugs.gentoo.org">bugs.gentoo.org</uri> to inform the documentation
157team about bugs regarding the Gentoo Documentation. You can add yourself by 157team about bugs regarding the Gentoo Documentation. You can add yourself by
158editing <path>/var/mail/alias/misc/docs-team</path> on dev.gentoo.org. 158editing <path>/var/mail/alias/misc/docs-team</path> on dev.gentoo.org.
159</p> 159</p>
160 160
165</p> 165</p>
166 166
167<p> 167<p>
168Depending on the assignment or responsibilities, a member may have limited CVS 168Depending on the assignment or responsibilities, a member may have limited CVS
169access to <c>cvs.gentoo.org</c>. Full CVS access is restricted to Gentoo 169access to <c>cvs.gentoo.org</c>. Full CVS access is restricted to Gentoo
170Developers. Read-only CVS access may be granted to recruits. 170Developers. An <uri link="http://anoncvs.gentoo.org">anonymous CVS server</uri>
171is available. It contains the same files as our CVS server but is a few minutes
172late.
171</p> 173</p>
172 174
173</body> 175</body>
174</section> 176</section>
175<section> 177<section>
185mentor(s) is/are in charge of the language. 187mentor(s) is/are in charge of the language.
186</p> 188</p>
187 189
188<p> 190<p>
189If a translated document for an unsupported language is contributed, the Gentoo 191If a translated document for an unsupported language is contributed, the Gentoo
190Documentation Team will not publish it officially. Such documents shall not be 192Documentation Team will publish it as-is. Such documents will not be linked to
191linked to the website until an official Translation Team of that language is 193the website until an official Translation Team of that language is formed, but
192formed. 194they will be available on our site and in CVS.
193</p> 195</p>
194 196
195<p> 197<p>
196When a language is officially supported, but the team does not have any 198When a language is officially supported, but the team does not have any
197members willing to take on the responsibilities of the <e>Lead 199members willing to take on the responsibilities of the <e>Lead
229Every document must have the following tag inside its GuideXML 231Every document must have the following tag inside its GuideXML
230source code between the <c>&lt;/abstract&gt;</c> and the <c>&lt;version&gt;</c> 232source code between the <c>&lt;/abstract&gt;</c> and the <c>&lt;version&gt;</c>
231tags: 233tags:
232</p> 234</p>
233 235
234<pre caption = "Licensing notice for the Gentoo Documentation"> 236<pre caption="Licensing notice for the Gentoo Documentation">
235&lt;/abstract&gt; 237&lt;/abstract&gt;
236<i> 238<i>
237&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt; 239&lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt;
238&lt;!-- See http://creativecommons.org/licenses/by-sa/2.5 --&gt; 240&lt;!-- See http://creativecommons.org/licenses/by-sa/2.5 --&gt;
239&lt;license/&gt; 241&lt;license/&gt;
257higher priority and should be addressed ahead any other task the assignee 259higher priority and should be addressed ahead any other task the assignee
258is responsible for. 260is responsible for.
259</p> 261</p>
260 262
261<p> 263<p>
262Whenever a Gentoo Documentation Team member takes care of a bug, he or 264Whenever a Gentoo Documentation Team member takes care of a bug, he or she
263she should assign the bug to herself/himself, but make sure that 265should assign the bug to herself/himself, but make sure that
264<c>docs-team@gentoo.org</c> is on the Cc-list. A bug may not be taken away from 266<mail>docs-team@gentoo.org</mail> is on the Cc-list. A bug may not be taken
265another Gentoo Documentation Team member without their approval; unless consent 267away from another Gentoo Documentation Team member without their approval;
266has been received from the Operational Manager. 268unless consent has been received from the Operational Manager.
267</p> 269</p>
268 270
269</body> 271</body>
270</section> 272</section>
271<section> 273<section>
290do not require a bug to be filed on <uri 292do not require a bug to be filed on <uri
291link="http://bugs.gentoo.org">bugs.gentoo.org</uri> as well. 293link="http://bugs.gentoo.org">bugs.gentoo.org</uri> as well.
292</p> 294</p>
293 295
294<p> 296<p>
295All changes in contents of the document, except for typo fixes in text 297All changes in contents of the document, except for typo fixes in text itself
296itself or in the comments to code listings, should lead to version 298or in the comments to code listings, should lead to version number and date
297number (and date) increase. Note that the change of a Code Listings should 299increase. Note that the change of a Code Listings should definitely cause an
298definitely cause an increase of the version number and date. 300increase of the version number and date.
299</p>
300
301<p> 301</p>
302
303<p>
302All changes in XML formatting should lead to version (and date) bumps only in 304All changes in XML formatting should lead to version and date bumps only in
303case the layout of the document changes. 305case the layout of the HTML document changes.
304</p> 306</p>
305 307
306<p> 308<p>
307Whether or not to increment the major version number instead of minor version 309Whether or not to increment the major version number instead of minor version
308number or other is up to the editor. 310number or other is up to the editor.
309</p> 311</p>
310 312
311<p> 313<p>
312Every update of a translation should copy the new version information 314Every update of a translation should use the version and date information
313verbatim from the master English document so fully synchronised 315verbatim from the master English document so fully synchronised translations
314translations have the same version information. 316have the same version and date.
315</p> 317</p>
316 318
317</body> 319</body>
318</section> 320</section>
319<section> 321<section>
341on the relevant changes regarding content and ignore the coding changes. 343on the relevant changes regarding content and ignore the coding changes.
342</p> 344</p>
343 345
344<p> 346<p>
345If the document in question is a translation, the <e>Lead Translator</e> of the 347If the document in question is a translation, the <e>Lead Translator</e> of the
346affected language is responsible for the document. Only the 348affected language is responsible for the document. Only the <e>Lead
347<e>Lead Translator</e> may commit the document to the CVS repository. However, 349Translator</e> and his follow-on may commit the document to the CVS repository.
348if the <e>Lead Translator</e> is currently "in training", the trainee's mentor 350However, if the <e>Lead Translator</e> is currently "in training", the
349should commit the changes. 351trainee's mentor should commit the changes.
350</p> 352</p>
351 353
352</body> 354</body>
353</section> 355</section>
354<section> 356<section>
390<body> 392<body>
391 393
392<p> 394<p>
393Everyone interested in contributing documentation, editing existing 395Everyone interested in contributing documentation, editing existing
394documentation, writing new documentation or translating documentation is 396documentation, writing new documentation or translating documentation is
395welcome to join the team. There are no rules or strings attached to 397welcome to send their contributions. There are no rules or strings attached to
396this. Just make sure you are subscribed to <c>gentoo-doc@gentoo.org</c>, 398this. Just make sure you are subscribed to <mail>gentoo-doc@gentoo.org</mail>,
397and you have fully read this policy and understand it. 399and you have fully read this policy and understand it.
398</p> 400</p>
399 401
400</body> 402</body>
401</section> 403</section>
412to cross. 414to cross.
413</p> 415</p>
414 416
415<p> 417<p>
416This recruitment process is meant only for requests to the Gentoo Documentation 418This recruitment process is meant only for requests to the Gentoo Documentation
417Repository through CVS. Being listed as the maintainer or Point-Of-Contact for a 419Repository through CVS. Being listed as the maintainer or point of contact for
418certain document or range of documents is granted by a simple request to the 420a certain document or range of documents is granted by a simple request to the
419Operational Manager or Project Lead. 421Operational Manager or Project Lead.
420</p> 422</p>
421 423
422</body> 424</body>
423</section> 425</section>
463An update constitutes a non-trivial update to any documentation, translation or 465An update constitutes a non-trivial update to any documentation, translation or
464otherwise, completely written by the contributor and committed after review by 466otherwise, completely written by the contributor and committed after review by
465any existing documentation developer. The period is fixed - increasing the 467any existing documentation developer. The period is fixed - increasing the
466contributions does not decrease the period. Also, we don't average the 468contributions does not decrease the period. Also, we don't average the
467contributions over time to make sure the contributor doesn't give a contribution 469contributions over time to make sure the contributor doesn't give a contribution
468burst, and then waits until the Phase is over. 470burst, and then waits until the phase is over.
469</p>
470
471<p> 471</p>
472
473<p>
472Without this phase we can not know if the contributor understands what it takes 474Without this phase, we can not know if the contributor understands what it
473to be a documentation developer. The validation of this activity happens through 475takes to be a documentation developer. The validation of this activity happens
474bugzilla reports. 476through bugzilla reports.
475</p> 477</p>
476 478
477<p> 479<p>
478Any request for CVS access that does not allow a development activity as written 480Any request for CVS access that does not allow a development activity as written
479down in the aforementioned table will not be taken into account. 481down in the aforementioned table will not be taken into account.
487</p> 489</p>
488 490
489</body> 491</body>
490</section> 492</section>
491<section> 493<section>
492<title>Phase 2: Read-Only CVS Access</title> 494<title>Phase 2: Start the Recruitment Process</title>
493<body> 495<body>
494 496
495<p> 497<p>
496During phase 2, the recruit is given read-only access to the Gentoo
497Documentation Repository, allowing him to generate commit-ready patches for
498the tree. During this period, which is roughly the same as the aforementioned 498During this period, which is roughly the same as the aforementioned table,
499table, his patches are not edited by a documentation developer anymore, but 499submitted patches are not edited by a documentation developer anymore, but are
500are either committed as-is or refused. The recruit is also assigned to a 500either committed as-is or refused. The recruit is also assigned to a full-time
501full-time documentation developer (the mentor) which will guide him through 501documentation developer (the mentor) which will guide him through these last
502these last phases. 502phases.
503</p> 503</p>
504 504
505<p> 505<p>
506The quality of the contributions are in this phase most important - every patch 506The quality of the contributions are in this phase most important - every patch
507that does not follow the Documentation Policy, Coding Style or other guideline 507that does not follow the Documentation Policy, Coding Style or other guideline
532<title>Phase 3: Gentoo Recruitment</title> 532<title>Phase 3: Gentoo Recruitment</title>
533<body> 533<body>
534 534
535<p> 535<p>
536When Phase 2 is finished, the Operational Manager will contact <uri 536When Phase 2 is finished, the Operational Manager will contact <uri
537link="/proj/en/devrel">Developer Relations</uri> and give a final "Go!" for the 537link="/proj/en/devrel/">Developer Relations</uri> and give a final "Go!" for the
538Gentoo recruitment process after which you will be given a Gentoo e-mail 538Gentoo recruitment process after which you will be given a Gentoo e-mail
539address and be appointed to one or more subprojects. 539address and be appointed to one or more subprojects.
540</p> 540</p>
541 541
542</body> 542</body>

Legend:
Removed from v.1.22  
changed lines
  Added in v.1.23

  ViewVC Help
Powered by ViewVC 1.1.20