/[gentoo]/xml/htdocs/proj/en/gdp/doc/doc-policy.xml
Gentoo

Contents of /xml/htdocs/proj/en/gdp/doc/doc-policy.xml

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.25 - (hide annotations) (download) (as text)
Tue Sep 27 17:55:35 2011 UTC (2 years, 11 months ago) by swift
Branch: MAIN
Changes since 1.24: +78 -176 lines
File MIME type: application/xml
Update on GDP policy - Improve wording to work with current development process, drop references to old names, update recruitment process, update on translation management (reflecting as-is situation more)

1 zhen 1.1 <?xml version='1.0' encoding="UTF-8"?>
2 swift 1.25 <!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-policy.xml,v 1.24 2010/11/08 22:54:00 nightmorph Exp $ -->
3 zhen 1.1 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
4    
5 nightmorph 1.24 <guide>
6 zhen 1.1 <title>Gentoo Linux Documentation Policy</title>
7 neysx 1.23
8 neysx 1.22 <author title="Author">
9     <mail link="neysx@gentoo.org">Xavier Neys</mail>
10 swift 1.3 </author>
11 neysx 1.23 <author title="Author">John P. Davis</author>
12 swift 1.3 <author title="Author">
13 neysx 1.21 <mail link="swift@gentoo.org">Sven Vermeulen</mail>
14 swift 1.3 </author>
15     <author title="Editor">
16 neysx 1.21 <mail link="dberkholz@gentoo.org">Donnie Berkholz</mail>
17 swift 1.3 </author>
18    
19 zhen 1.1 <abstract>
20 swift 1.3 This document contains the Gentoo Documentation Policy, which is the
21     base document which all Gentoo Documentation developers and
22 swift 1.16 Contributors should know and exercise.
23 zhen 1.1 </abstract>
24    
25 nightmorph 1.24 <!-- The content of this document is licensed under the CC-BY-SA license -->
26     <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
27 swift 1.3 <license/>
28    
29 swift 1.25 <version>6</version>
30     <date>2011-09-23</date>
31 zhen 1.1
32     <chapter>
33 swift 1.3 <title>Introduction</title>
34     <section>
35     <title>Introduction</title>
36     <body>
37    
38     <p>
39 neysx 1.21 The Gentoo Linux Documentation team aspires to create exceptionally
40     professional documentation that is immediately clear and concise to the
41     end user. In order to fulfill this goal, we have very specific rules and
42 swift 1.25 guidelines that our documentation must go through prior to
43 swift 1.16 dissemination on our website, or elsewhere.
44 swift 1.3 </p>
45    
46     </body>
47     </section>
48     <section>
49     <title>Covered Topics</title>
50     <body>
51    
52     <p>
53 neysx 1.21 This policy will cover the following topics:
54 swift 1.3 </p>
55    
56     <ul>
57     <li>Documentation Project Team Organization</li>
58     <li>Documentation Guidelines</li>
59 swift 1.13 <li>Documentation Team Recruitment</li>
60 swift 1.3 </ul>
61 zhen 1.1
62 swift 1.3 </body>
63     </section>
64 zhen 1.1 </chapter>
65    
66     <chapter>
67 swift 1.3 <title>Documentation Project Team Organization</title>
68     <section>
69     <title>Organization</title>
70     <body>
71    
72     <p>
73 swift 1.25 The Gentoo Documentation Project Team consists of editors and authors, working
74     on our main documentation and its translations. Like most other Gentoo projects,
75     it is lead by a project lead whose additional job is to look after the team and
76     its resources in general (such as focusing on recruitment when necessary and
77     acting as an unbiased mediator when two or more developers have a dispute over
78     something).
79 swift 1.3 </p>
80    
81     <p>
82 swift 1.25 When the Gentoo Documentation Team launches any subprojects, you will find its
83     mission on our <uri link="/proj/en/gdp/">GDP Project Webpage</uri>, along with
84     their respective project leads.
85 swift 1.3 </p>
86    
87     </body>
88     </section>
89     <section>
90     <title>Documentation Project Team Members</title>
91     <body>
92    
93     <p>
94     Every member of the Gentoo Documentation Project must be subscribed to
95 neysx 1.23 the <mail link="gentoo-doc+subscribe@gentoo.org">gentoo-doc@gentoo.org</mail>
96 swift 1.3 mailing list. This mailing list will be used to discuss all
97     documentation-related issues. This mailing list is open to all interested
98     parties, developer or not.
99     </p>
100    
101     <p>
102 swift 1.11 Every member of the Gentoo Documentation Project must be part of the
103 neysx 1.23 <mail>docs-team@gentoo.org</mail> alias. This alias is <e>only</e> used by <uri
104 neysx 1.9 link="http://bugs.gentoo.org">bugs.gentoo.org</uri> to inform the documentation
105 swift 1.11 team about bugs regarding the Gentoo Documentation. You can add yourself by
106 swift 1.25 editing <path>/var/mail/alias/misc/docs-team</path> on dev.gentoo.org. Please do
107     <e>not</e> use this address to try and contact the team - you can contact us
108     through the mailinglist, IRC or by mailing the project lead or any other member.
109 swift 1.3 </p>
110    
111     <p>
112 swift 1.25 Members of the Gentoo Documentation Team are frequently online in
113     <c>#gentoo-doc</c> on <uri link="http://www.freenode.net">irc.freenode.net</uri>.
114 swift 1.3 </p>
115    
116     <p>
117 swift 1.25 Depending on the assignment or responsibilities, a member may have CVS
118     access to <c>cvs.gentoo.org</c>. Interested non-developers can use the
119     <uri link="http://anoncvs.gentoo.org">anonymous CVS server</uri>
120     to help out with the documentation. It contains the same files as our CVS
121     server but is a few minutes late.
122 swift 1.3 </p>
123    
124     </body>
125     </section>
126     <section>
127     <title>Documentation Translation Teams</title>
128     <body>
129    
130     <p>
131 swift 1.15 Every language should be backed up by an official Translation Team. This
132 neysx 1.21 team is led by a <e>Lead Translator</e> and perhaps a <e>Follow-On Lead
133 swift 1.25 Translator</e>, who both have CVS commit access. Organization of the
134     translations is handled by the lead translator as he or she sees fit, as
135     long as the committed translations follow this policy.
136 swift 1.3 </p>
137    
138     <p>
139 swift 1.15 If a translated document for an unsupported language is contributed, the Gentoo
140 neysx 1.23 Documentation Team will publish it as-is. Such documents will not be linked to
141     the website until an official Translation Team of that language is formed, but
142     they will be available on our site and in CVS.
143 swift 1.3 </p>
144    
145     <p>
146 neysx 1.21 For more information Gentoo document translations, please consult the
147 swift 1.15 <uri link="/proj/en/gdp/doc/translators-howto.xml">
148 neysx 1.21 Translators Howto for Gentoo Documentation</uri> and the
149 swift 1.15 <uri link="/proj/en/gdp/international.xml">
150     GDP Internationalisation Subproject</uri> page.
151     </p>
152    
153 swift 1.3 </body>
154     </section>
155 zhen 1.1 </chapter>
156    
157 swift 1.3 <chapter>
158     <title>Gentoo Documentation Guidelines</title>
159     <section>
160     <title>Legal Issues</title>
161     <body>
162    
163     <p>
164     Every document published by the Gentoo Documentation Project must be
165 neysx 1.21 licensed by the <uri
166     link="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons
167     Attribution-ShareAlike License</uri>.
168 swift 1.3 </p>
169    
170     <p>
171     Every document must have the following tag inside its GuideXML
172 swift 1.13 source code between the <c>&lt;/abstract&gt;</c> and the <c>&lt;version&gt;</c>
173 swift 1.3 tags:
174     </p>
175    
176 neysx 1.23 <pre caption="Licensing notice for the Gentoo Documentation">
177 swift 1.3 &lt;/abstract&gt;
178     <i>
179     &lt;!-- The content of this document is licensed under the CC-BY-SA license --&gt;
180 jkt 1.17 &lt;!-- See http://creativecommons.org/licenses/by-sa/2.5 --&gt;
181 swift 1.3 &lt;license/&gt;
182     </i>
183     &lt;version&gt;...&lt;/version&gt;
184     </pre>
185    
186     </body>
187     </section>
188     <section>
189     <title>Bugs and Updates</title>
190     <body>
191    
192     <p>
193     Every bug reported on <uri link="http://bugs.gentoo.org">bugs.gentoo.org</uri>
194 neysx 1.21 should be handled as fast as possible. If a bug cannot be handled
195 swift 1.3 in a timely fashion, the reporter of that bug should be informed about
196 neysx 1.21 this using a comment on the bug, and the bug should be registered in the
197     <uri link="/proj/en/gdp/doc/metadoc-guide.xml">metadoc.xml</uri> file, if
198 swift 1.25 applicable.
199 swift 1.3 </p>
200    
201     <p>
202 neysx 1.23 Whenever a Gentoo Documentation Team member takes care of a bug, he or she
203     should assign the bug to herself/himself, but make sure that
204     <mail>docs-team@gentoo.org</mail> is on the Cc-list. A bug may not be taken
205 swift 1.25 away from another Gentoo Documentation Team member without their approval
206     unless consent has been received from the project lead.
207 swift 1.3 </p>
208    
209     </body>
210     </section>
211     <section>
212     <title>Document Development</title>
213     <body>
214    
215     <p>
216 swift 1.15 Every Gentoo Documentation Team may handle documentation development as it sees
217 neysx 1.21 fit. However, when the document is finished, it should be transformed into
218     <uri link="/doc/en/xml-guide.xml">GuideXML</uri> and made available on the
219 swift 1.15 Gentoo CVS infrastructure. It must also be registered in the
220 swift 1.8 <uri link="/proj/en/gdp/doc/metadoc-guide.xml">metadoc.xml</uri> file if
221     applicable.
222 swift 1.3 </p>
223    
224     <p>
225 neysx 1.21 When a new document is started or a big change is needed, a bug should be filed
226 swift 1.3 at <uri link="http://bugs.gentoo.org">bugs.gentoo.org</uri>
227     concerning the development of this document. If there is already a bug
228     in the database that requests a change to the documentation, a new bug
229     does not have to be filed. Grammatical, syntactical or small changes
230 neysx 1.21 do not require a bug to be filed on <uri
231 swift 1.3 link="http://bugs.gentoo.org">bugs.gentoo.org</uri> as well.
232     </p>
233    
234     <p>
235 neysx 1.23 All changes in contents of the document, except for typo fixes in text itself
236     or in the comments to code listings, should lead to version number and date
237     increase. Note that the change of a Code Listings should definitely cause an
238     increase of the version number and date.
239 swift 1.3 </p>
240    
241     <p>
242 neysx 1.23 All changes in XML formatting should lead to version and date bumps only in
243     case the layout of the HTML document changes.
244 swift 1.3 </p>
245    
246     <p>
247 swift 1.25 Versions should always be handled as integers, so a version bump of version
248     <c>2</c> leads to version <c>3</c>. Historical versions that use the major and
249     minor syntax should be converted to the next integer on the next update, so
250     version <c>3.2</c> becomes version <c>4</c>.
251 swift 1.3 </p>
252    
253     <p>
254 neysx 1.23 Every update of a translation should use the version and date information
255     verbatim from the master English document so fully synchronised translations
256     have the same version and date.
257 swift 1.3 </p>
258    
259     </body>
260     </section>
261     <section>
262     <title>Reviewing and Committing</title>
263     <body>
264    
265     <p>
266 swift 1.15 To maintain a high-paced documentation development cycle, technical or
267     intrusive changes to documents can be propagated immediately to the document.
268     This is allowed only <e>if</e> the editor is absolutely confident the changes
269 swift 1.25 are functionally correct. If you are not absolutely confident (for instance because a
270 swift 1.15 user has told you how to fix it but you cannot verify yourself), have the
271 swift 1.25 changes reviewed by a third person that can verify the changes are apt.
272 swift 1.3 </p>
273    
274     <p>
275 swift 1.15 High-volume, technical or intrusive changes must be accompanied by a bug report
276     on <uri>http://bugs.gentoo.org</uri>. This bug number <e>must</e> be mentioned
277 swift 1.13 in the CVS log to allow backtracing of changes.
278 swift 1.3 </p>
279    
280     <p>
281 swift 1.15 If a bugfix includes changes to content as well as internal coding changes,
282     both changes must be committed separately. This allows translators to focus
283     on the relevant changes regarding content and ignore the coding changes.
284 swift 1.3 </p>
285    
286     </body>
287     </section>
288     <section>
289     <title>Sanctions</title>
290     <body>
291    
292     <p>
293 swift 1.25 Malicious conduct by developers has not been an issue before. However, it
294     should be noted that documentation developers that misuse their position by
295 swift 1.3 </p>
296    
297     <ul>
298     <li>deliberately providing wrong information to users or developers</li>
299     <li>deliberately writing flawed documentation</li>
300     <li>deliberately corrupting documents</li>
301     <li>
302     deliberately go against the decisions made policy-wise or through a
303     consensus-model on the Gentoo Documentation mailinglist
304     </li>
305 swift 1.25 <li>not performing at all for a long time without informing the GDP</li>
306 swift 1.3 </ul>
307    
308     <p>
309 neysx 1.9 will be reported to the <uri link="/proj/en/devrel/">Gentoo Developer
310 swift 1.3 Relations</uri> project.
311     </p>
312 zhen 1.1
313 swift 1.3 </body>
314     </section>
315 zhen 1.1 </chapter>
316 swift 1.3
317 zhen 1.1 <chapter>
318 swift 1.16 <title>Documentation Team Recruitment</title>
319 swift 1.3 <section>
320     <title>Contributors, Authors, Translators</title>
321     <body>
322    
323     <p>
324     Everyone interested in contributing documentation, editing existing
325     documentation, writing new documentation or translating documentation is
326 neysx 1.23 welcome to send their contributions. There are no rules or strings attached to
327     this. Just make sure you are subscribed to <mail>gentoo-doc@gentoo.org</mail>,
328 swift 1.3 and you have fully read this policy and understand it.
329     </p>
330    
331     </body>
332     </section>
333     <section>
334 swift 1.11 <title>Recruitment Process</title>
335 swift 1.3 <body>
336    
337     <p>
338 swift 1.25 The Documentation Project uses the recruitment process outlined below.
339     We have opted for this recruitment process to assure ourselves that the recruit
340     is well informed about the Gentoo Documentation Policy and the Gentoo Coding
341     Style. It has proven to be quite effective even though many contributors see it
342     as a too large burden to cross.
343 swift 1.3 </p>
344    
345     <p>
346 swift 1.11 This recruitment process is meant only for requests to the Gentoo Documentation
347 neysx 1.23 Repository through CVS. Being listed as the maintainer or point of contact for
348 swift 1.25 a certain document or range of documents does not require developer access.
349 swift 1.11 </p>
350    
351     </body>
352     </section>
353     <section>
354     <title>Phase 1: Contributions</title>
355     <body>
356    
357     <p>
358     No recruitment process starts without investigating the contributions done
359     already to the Gentoo Documentation Project. The number of contributions must be
360 neysx 1.21 large to assure a good knowledge of GuideXML, Coding Style and policy. The
361 swift 1.25 contribution period must be large as well to allow the contributor to find out
362     if he can provide continuous support for the Gentoo Documentation Project.
363 swift 1.11 </p>
364    
365     <p>
366     An update constitutes a non-trivial update to any documentation, translation or
367 swift 1.25 otherwise, completely written or edited by the contributor and committed after
368     review by any existing documentation developer.
369 swift 1.3 </p>
370    
371     <p>
372 neysx 1.21 If you feel that you have shown sufficient amount of contributions, contact
373 swift 1.25 the project lead of the Gentoo Documentation Project. He will ask you for your
374     coordinates and other information, and then arrange for the next phase to be
375     started.
376 swift 1.3 </p>
377    
378     </body>
379     </section>
380     <section>
381 neysx 1.23 <title>Phase 2: Start the Recruitment Process</title>
382 swift 1.3 <body>
383    
384     <p>
385 swift 1.25 During this period, submitted patches are not edited by a documentation
386     developer anymore, but are either committed as-is or refused. The recruit is
387     also assigned to a documentation developer (the mentor) which will guide him
388     through these last phases.
389 swift 1.11 </p>
390    
391     <p>
392     The quality of the contributions are in this phase most important - every patch
393     that does not follow the Documentation Policy, Coding Style or other guideline
394 swift 1.25 that affects the document is tackled by the recruit himself with help of the
395     mentor.
396 swift 1.3 </p>
397    
398     <p>
399 swift 1.25 During this period, the recruit:
400 swift 1.3 </p>
401    
402 swift 1.11 <ul>
403     <li>
404 swift 1.25 is advised to learn about Gentoo's inner workings.
405     This is required as he or she will be asked later on to answer Gentoo's <uri
406 swift 1.11 link="/proj/en/devrel/quiz/staff-quiz.txt">Staffing Quiz</uri>.
407     </li>
408     <li>
409 neysx 1.21 will be asked to fill in the <uri
410 swift 1.11 link="/proj/en/gdp/doc/doc-quiz.xml">Gentoo Documentation Project
411 swift 1.25 Quiz</uri>. He or she needs to successfully pass this entire quiz
412     (all questions) before we can continue with the next Phase.
413 swift 1.11 </li>
414     </ul>
415    
416     </body>
417     </section>
418     <section>
419     <title>Phase 3: Gentoo Recruitment</title>
420     <body>
421    
422 swift 1.3 <p>
423 swift 1.25 When Phase 2 is finished, the project lead will contact <uri
424 neysx 1.23 link="/proj/en/devrel/">Developer Relations</uri> and give a final "Go!" for the
425 swift 1.25 Gentoo recruitment process after which the recruit will be given access to the
426     necessary Gentoo infrastructural services (like the documentation repository).
427     </p>
428    
429     </body>
430     </section>
431     <section>
432     <title>Recruitment of Existing Gentoo Developers</title>
433     <body>
434    
435     <p>
436     If the recruit is already a Gentoo Developer, the same recruitment process is
437     followed, but the staffing quiz is not necessary anymore. However, the <uri
438     link="/proj/en/gdp/doc/doc-quiz.xml">Gentoo Documentation Project Quiz</uri> is
439     still mandatory.
440 swift 1.3 </p>
441 zhen 1.1
442 swift 1.3 </body>
443     </section>
444 zhen 1.1 </chapter>
445     </guide>

  ViewVC Help
Powered by ViewVC 1.1.20