| 1 |
swift 11/09/27 17:55:35 |
| 2 |
|
| 3 |
Modified: doc-policy.xml |
| 4 |
Log: |
| 5 |
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) |
| 6 |
|
| 7 |
Revision Changes Path |
| 8 |
1.25 xml/htdocs/proj/en/gdp/doc/doc-policy.xml |
| 9 |
|
| 10 |
file : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/gdp/doc/doc-policy.xml?rev=1.25&view=markup |
| 11 |
plain: http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/gdp/doc/doc-policy.xml?rev=1.25&content-type=text/plain |
| 12 |
diff : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/gdp/doc/doc-policy.xml?r1=1.24&r2=1.25 |
| 13 |
|
| 14 |
Index: doc-policy.xml |
| 15 |
=================================================================== |
| 16 |
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-policy.xml,v |
| 17 |
retrieving revision 1.24 |
| 18 |
retrieving revision 1.25 |
| 19 |
diff -u -r1.24 -r1.25 |
| 20 |
--- doc-policy.xml 8 Nov 2010 22:54:00 -0000 1.24 |
| 21 |
+++ doc-policy.xml 27 Sep 2011 17:55:35 -0000 1.25 |
| 22 |
@@ -1,5 +1,5 @@ |
| 23 |
<?xml version='1.0' encoding="UTF-8"?> |
| 24 |
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-policy.xml,v 1.24 2010/11/08 22:54:00 nightmorph Exp $ --> |
| 25 |
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-policy.xml,v 1.25 2011/09/27 17:55:35 swift Exp $ --> |
| 26 |
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> |
| 27 |
|
| 28 |
<guide> |
| 29 |
@@ -26,8 +26,8 @@ |
| 30 |
<!-- See http://creativecommons.org/licenses/by-sa/2.5 --> |
| 31 |
<license/> |
| 32 |
|
| 33 |
-<version>5</version> |
| 34 |
-<date>2010-11-08</date> |
| 35 |
+<version>6</version> |
| 36 |
+<date>2011-09-23</date> |
| 37 |
|
| 38 |
<chapter> |
| 39 |
<title>Introduction</title> |
| 40 |
@@ -39,7 +39,7 @@ |
| 41 |
The Gentoo Linux Documentation team aspires to create exceptionally |
| 42 |
professional documentation that is immediately clear and concise to the |
| 43 |
end user. In order to fulfill this goal, we have very specific rules and |
| 44 |
-guidelines that <e>all</e> documentation must go through prior to |
| 45 |
+guidelines that our documentation must go through prior to |
| 46 |
dissemination on our website, or elsewhere. |
| 47 |
</p> |
| 48 |
|
| 49 |
@@ -70,68 +70,18 @@ |
| 50 |
<body> |
| 51 |
|
| 52 |
<p> |
| 53 |
-The Gentoo Documentation Project Team is split into several smaller teams |
| 54 |
-that work in tandem with each other. Each smaller team represents an active |
| 55 |
-development team of a Gentoo Documentation Subproject. |
| 56 |
+The Gentoo Documentation Project Team consists of editors and authors, working |
| 57 |
+on our main documentation and its translations. Like most other Gentoo projects, |
| 58 |
+it is lead by a project lead whose additional job is to look after the team and |
| 59 |
+its resources in general (such as focusing on recruitment when necessary and |
| 60 |
+acting as an unbiased mediator when two or more developers have a dispute over |
| 61 |
+something). |
| 62 |
</p> |
| 63 |
|
| 64 |
-<!-- |
| 65 |
<p> |
| 66 |
-The Gentoo Documentation Project is strategically led by a top-level Manager |
| 67 |
-as required by the <uri link="/doc/en/management-structure.xml">Gentoo |
| 68 |
-Management Structure</uri>. This document also describes the responsibilities |
| 69 |
-of the Strategic Manager with respect to Gentoo Linux. |
| 70 |
-</p> |
| 71 |
---> |
| 72 |
- |
| 73 |
-<p> |
| 74 |
-For day-to-day managerial tasks, the Gentoo Documentation Project has an |
| 75 |
-Operational Manager. This person keeps track of all short-term tasks |
| 76 |
-related to documentation. The Operational Manager and Strategic Manager can be |
| 77 |
-one and the same if the Strategic Manager wishes so. |
| 78 |
-</p> |
| 79 |
- |
| 80 |
-<p> |
| 81 |
-Currently these positions are taken by the following people: |
| 82 |
-</p> |
| 83 |
- |
| 84 |
-<table> |
| 85 |
-<tr> |
| 86 |
- <th>Position</th> |
| 87 |
- <th>Developer Name</th> |
| 88 |
- <th>Developer Nick</th> |
| 89 |
-</tr> |
| 90 |
-<tr> |
| 91 |
- <ti>Strategic Manager</ti> |
| 92 |
- <ti>Joshua Saddler</ti> |
| 93 |
- <ti><mail link="nightmorph@g.o">nightmorph</mail></ti> |
| 94 |
-</tr> |
| 95 |
-<tr> |
| 96 |
- <ti>Operational Manager</ti> |
| 97 |
- <ti>Joshua Saddler</ti> |
| 98 |
- <ti><mail link="nightmorph@g.o">nightmorph</mail></ti> |
| 99 |
-</tr> |
| 100 |
-</table> |
| 101 |
- |
| 102 |
-<!-- |
| 103 |
-<p> |
| 104 |
-Every subproject has a Strategic Manager of its own, and may have an |
| 105 |
-Operational Manager if deemed appropriate. His responsibilities to the Gentoo |
| 106 |
-Documentation Project (GDP) are listed in the <e>Manager responsibilities</e> |
| 107 |
-section of the <uri |
| 108 |
-link="/doc/en/management-structure.xml#doc_chap1_sect5">Gentoo Management |
| 109 |
-Structure</uri> document. |
| 110 |
-</p> |
| 111 |
---> |
| 112 |
- |
| 113 |
-<p> |
| 114 |
-Every subproject of the Gentoo Documentation Team is listed on the |
| 115 |
-<uri link="/proj/en/gdp/">GDP Webpage</uri>, along with their respective |
| 116 |
-Strategic Managers. |
| 117 |
-</p> |
| 118 |
- |
| 119 |
-<p> |
| 120 |
-The decision on adding a subproject is in the hands of the Strategic Manager. |
| 121 |
+When the Gentoo Documentation Team launches any subprojects, you will find its |
| 122 |
+mission on our <uri link="/proj/en/gdp/">GDP Project Webpage</uri>, along with |
| 123 |
+their respective project leads. |
| 124 |
</p> |
| 125 |
|
| 126 |
</body> |
| 127 |
@@ -153,21 +103,22 @@ |
| 128 |
<mail>docs-team@g.o</mail> alias. This alias is <e>only</e> used by <uri |
| 129 |
link="http://bugs.gentoo.org">bugs.gentoo.org</uri> to inform the documentation |
| 130 |
team about bugs regarding the Gentoo Documentation. You can add yourself by |
| 131 |
-editing <path>/var/mail/alias/misc/docs-team</path> on dev.gentoo.org. |
| 132 |
+editing <path>/var/mail/alias/misc/docs-team</path> on dev.gentoo.org. Please do |
| 133 |
+<e>not</e> use this address to try and contact the team - you can contact us |
| 134 |
+through the mailinglist, IRC or by mailing the project lead or any other member. |
| 135 |
</p> |
| 136 |
|
| 137 |
<p> |
| 138 |
-Members of the Gentoo Documentation Team should be available at |
| 139 |
-<c>#gentoo-doc</c> on <uri link="http://www.freenode.net">irc.freenode.net</uri> |
| 140 |
-whenever they are online. |
| 141 |
+Members of the Gentoo Documentation Team are frequently online in |
| 142 |
+<c>#gentoo-doc</c> on <uri link="http://www.freenode.net">irc.freenode.net</uri>. |
| 143 |
</p> |
| 144 |
|
| 145 |
<p> |
| 146 |
-Depending on the assignment or responsibilities, a member may have limited CVS |
| 147 |
-access to <c>cvs.gentoo.org</c>. Full CVS access is restricted to Gentoo |
| 148 |
-Developers. An <uri link="http://anoncvs.gentoo.org">anonymous CVS server</uri> |
| 149 |
-is available. It contains the same files as our CVS server but is a few minutes |
| 150 |
-late. |
| 151 |
+Depending on the assignment or responsibilities, a member may have CVS |
| 152 |
+access to <c>cvs.gentoo.org</c>. Interested non-developers can use the |
| 153 |
+<uri link="http://anoncvs.gentoo.org">anonymous CVS server</uri> |
| 154 |
+to help out with the documentation. It contains the same files as our CVS |
| 155 |
+server but is a few minutes late. |
| 156 |
</p> |
| 157 |
|
| 158 |
</body> |
| 159 |
@@ -179,10 +130,9 @@ |
| 160 |
<p> |
| 161 |
Every language should be backed up by an official Translation Team. This |
| 162 |
team is led by a <e>Lead Translator</e> and perhaps a <e>Follow-On Lead |
| 163 |
-Translator</e>, who both have CVS commit access. If for any reason the |
| 164 |
-<e>Lead Translator</e> cannot perform his duties, the <e>Follow-On Lead |
| 165 |
-Translator</e> is in charge. If the <e>Follow-On</e> is unavailable, the |
| 166 |
-mentor(s) is/are in charge of the language. |
| 167 |
+Translator</e>, who both have CVS commit access. Organization of the |
| 168 |
+translations is handled by the lead translator as he or she sees fit, as |
| 169 |
+long as the committed translations follow this policy. |
| 170 |
</p> |
| 171 |
|
| 172 |
<p> |
| 173 |
@@ -193,14 +143,6 @@ |
| 174 |
</p> |
| 175 |
|
| 176 |
<p> |
| 177 |
-When a language is officially supported, but the team does not have any |
| 178 |
-members willing to take on the responsibilities of the <e>Lead |
| 179 |
-Translator</e>, all links to the documents will be removed from the site. |
| 180 |
-However, the documents will stay available in case the language becomes |
| 181 |
-officially supported again. |
| 182 |
-</p> |
| 183 |
- |
| 184 |
-<p> |
| 185 |
For more information Gentoo document translations, please consult the |
| 186 |
<uri link="/proj/en/gdp/doc/translators-howto.xml"> |
| 187 |
Translators Howto for Gentoo Documentation</uri> and the |
| 188 |
@@ -253,17 +195,15 @@ |
| 189 |
in a timely fashion, the reporter of that bug should be informed about |
| 190 |
this using a comment on the bug, and the bug should be registered in the |
| 191 |
<uri link="/proj/en/gdp/doc/metadoc-guide.xml">metadoc.xml</uri> file, if |
| 192 |
-applicable. The Strategic or Operational Manager may decide that a bug has a |
| 193 |
-higher priority and should be addressed ahead any other task the assignee |
| 194 |
-is responsible for. |
| 195 |
+applicable. |
| 196 |
</p> |
| 197 |
|
| 198 |
<p> |
| 199 |
Whenever a Gentoo Documentation Team member takes care of a bug, he or she |
| 200 |
should assign the bug to herself/himself, but make sure that |
| 201 |
<mail>docs-team@g.o</mail> is on the Cc-list. A bug may not be taken |
| 202 |
-away from another Gentoo Documentation Team member without their approval; |
| 203 |
-unless consent has been received from the Operational Manager. |
| 204 |
+away from another Gentoo Documentation Team member without their approval |
| 205 |
+unless consent has been received from the project lead. |
| 206 |
</p> |
| 207 |
|
| 208 |
</body> |
| 209 |
@@ -304,8 +244,10 @@ |
| 210 |
</p> |
| 211 |
|
| 212 |
<p> |
| 213 |
-Whether or not to increment the major version number instead of minor version |
| 214 |
-number or other is up to the editor. |
| 215 |
+Versions should always be handled as integers, so a version bump of version |
| 216 |
+<c>2</c> leads to version <c>3</c>. Historical versions that use the major and |
| 217 |
+minor syntax should be converted to the next integer on the next update, so |
| 218 |
+version <c>3.2</c> becomes version <c>4</c>. |
| 219 |
</p> |
| 220 |
|
| 221 |
<p> |
| 222 |
@@ -324,9 +266,9 @@ |
| 223 |
To maintain a high-paced documentation development cycle, technical or |
| 224 |
intrusive changes to documents can be propagated immediately to the document. |
| 225 |
This is allowed only <e>if</e> the editor is absolutely confident the changes |
| 226 |
-are functional. If you are not absolutely confident (for instance because a |
| 227 |
+are functionally correct. If you are not absolutely confident (for instance because a |
| 228 |
user has told you how to fix it but you cannot verify yourself), have the |
| 229 |
-changes reviewed by a Gentoo Developer that can verify the changes are apt. |
| 230 |
+changes reviewed by a third person that can verify the changes are apt. |
| 231 |
</p> |
| 232 |
|
| 233 |
<p> |
| 234 |
@@ -341,14 +283,6 @@ |
| 235 |
on the relevant changes regarding content and ignore the coding changes. |
| 236 |
</p> |
| 237 |
|
| 238 |
-<p> |
| 239 |
-If the document in question is a translation, the <e>Lead Translator</e> of the |
| 240 |
-affected language is responsible for the document. Only the <e>Lead |
| 241 |
-Translator</e> and his follow-on may commit the document to the CVS repository. |
| 242 |
-However, if the <e>Lead Translator</e> is currently "in training", the |
| 243 |
-trainee's mentor should commit the changes. |
| 244 |
-</p> |
| 245 |
- |
| 246 |
</body> |
| 247 |
</section> |
| 248 |
<section> |
| 249 |
@@ -356,8 +290,8 @@ |
| 250 |
<body> |
| 251 |
|
| 252 |
<p> |
| 253 |
-Malicious conduct by developers has never been an issue. However, it should be |
| 254 |
-noted that documentation developers that misuse their position by |
| 255 |
+Malicious conduct by developers has not been an issue before. However, it |
| 256 |
+should be noted that documentation developers that misuse their position by |
| 257 |
</p> |
| 258 |
|
| 259 |
<ul> |
| 260 |
@@ -368,10 +302,7 @@ |
| 261 |
deliberately go against the decisions made policy-wise or through a |
| 262 |
consensus-model on the Gentoo Documentation mailinglist |
| 263 |
</li> |
| 264 |
- <li> |
| 265 |
- not performing at all for a long time without informing the GDP, and without |
| 266 |
- replying to the Operational Manager's request for a status update |
| 267 |
- </li> |
| 268 |
+ <li>not performing at all for a long time without informing the GDP</li> |
| 269 |
</ul> |
| 270 |
|
| 271 |
<p> |
| 272 |
@@ -404,19 +335,17 @@ |
| 273 |
<body> |
| 274 |
|
| 275 |
<p> |
| 276 |
-The Documentation Project has a strict recruitment process outlined below. |
| 277 |
-This process can not be deviated from in any circumstance. We have opted for |
| 278 |
-this recruitment process to assure ourselves that the recruit is well informed |
| 279 |
-about the Gentoo Documentation Policy and the Gentoo Coding Style. It has proven |
| 280 |
-to be quite effective even though many contributors see it as a too large burden |
| 281 |
-to cross. |
| 282 |
+The Documentation Project uses the recruitment process outlined below. |
| 283 |
+We have opted for this recruitment process to assure ourselves that the recruit |
| 284 |
+is well informed about the Gentoo Documentation Policy and the Gentoo Coding |
| 285 |
+Style. It has proven to be quite effective even though many contributors see it |
| 286 |
+as a too large burden to cross. |
| 287 |
</p> |
| 288 |
|
| 289 |
<p> |
| 290 |
This recruitment process is meant only for requests to the Gentoo Documentation |
| 291 |
Repository through CVS. Being listed as the maintainer or point of contact for |
| 292 |
-a certain document or range of documents is granted by a simple request to the |
| 293 |
-Operational Manager or Project Lead. |
| 294 |
+a certain document or range of documents does not require developer access. |
| 295 |
</p> |
| 296 |
|
| 297 |
</body> |
| 298 |
@@ -429,61 +358,21 @@ |
| 299 |
No recruitment process starts without investigating the contributions done |
| 300 |
already to the Gentoo Documentation Project. The number of contributions must be |
| 301 |
large to assure a good knowledge of GuideXML, Coding Style and policy. The |
| 302 |
-contribution period must be large as well to inform the contributor about the |
| 303 |
-time-consuming position and pressure the application involves. |
| 304 |
+contribution period must be large as well to allow the contributor to find out |
| 305 |
+if he can provide continuous support for the Gentoo Documentation Project. |
| 306 |
</p> |
| 307 |
|
| 308 |
<p> |
| 309 |
-The number of contributions and period over which the contributions should be |
| 310 |
-made depends on the position which the contributor solicits for. Although it is |
| 311 |
-difficult to write down these measurements in numbers, the following table |
| 312 |
-should give a general overview. Final decision however lays in the hands of the |
| 313 |
-Operational Manager. |
| 314 |
-</p> |
| 315 |
- |
| 316 |
-<table> |
| 317 |
-<tr> |
| 318 |
- <th>Position</th> |
| 319 |
- <th>Minimal Activity</th> |
| 320 |
- <th>Minimal Period</th> |
| 321 |
-</tr> |
| 322 |
-<tr> |
| 323 |
- <ti>Full-time Developer</ti> |
| 324 |
- <ti>2 updates per week</ti> |
| 325 |
- <ti>1 month</ti> |
| 326 |
-</tr> |
| 327 |
-<tr> |
| 328 |
- <ti>Part-time Developer</ti> |
| 329 |
- <ti>4 updates per month</ti> |
| 330 |
- <ti>1 month</ti> |
| 331 |
-</tr> |
| 332 |
-</table> |
| 333 |
- |
| 334 |
-<p> |
| 335 |
An update constitutes a non-trivial update to any documentation, translation or |
| 336 |
-otherwise, completely written by the contributor and committed after review by |
| 337 |
-any existing documentation developer. The period is fixed - increasing the |
| 338 |
-contributions does not decrease the period. Also, we don't average the |
| 339 |
-contributions over time to make sure the contributor doesn't give a contribution |
| 340 |
-burst, and then waits until the phase is over. |
| 341 |
-</p> |
| 342 |
- |
| 343 |
-<p> |
| 344 |
-Without this phase, we can not know if the contributor understands what it |
| 345 |
-takes to be a documentation developer. The validation of this activity happens |
| 346 |
-through bugzilla reports. |
| 347 |
-</p> |
| 348 |
- |
| 349 |
-<p> |
| 350 |
-Any request for CVS access that does not allow a development activity as written |
| 351 |
-down in the aforementioned table will not be taken into account. |
| 352 |
+otherwise, completely written or edited by the contributor and committed after |
| 353 |
+review by any existing documentation developer. |
| 354 |
</p> |
| 355 |
|
| 356 |
<p> |
| 357 |
If you feel that you have shown sufficient amount of contributions, contact |
| 358 |
-the Operational Manager of the Gentoo Documentation Project. He |
| 359 |
-will ask you for your coordinates and other information, and then arrange |
| 360 |
-for the next phase to be started. |
| 361 |
+the project lead of the Gentoo Documentation Project. He will ask you for your |
| 362 |
+coordinates and other information, and then arrange for the next phase to be |
| 363 |
+started. |
| 364 |
</p> |
| 365 |
|
| 366 |
</body> |
| 367 |
@@ -493,34 +382,34 @@ |
| 368 |
<body> |
| 369 |
|
| 370 |
<p> |
| 371 |
-During this period, which is roughly the same as the aforementioned table, |
| 372 |
-submitted patches are not edited by a documentation developer anymore, but are |
| 373 |
-either committed as-is or refused. The recruit is also assigned to a full-time |
| 374 |
-documentation developer (the mentor) which will guide him through these last |
| 375 |
-phases. |
| 376 |
+During this period, submitted patches are not edited by a documentation |
| 377 |
+developer anymore, but are either committed as-is or refused. The recruit is |
| 378 |
+also assigned to a documentation developer (the mentor) which will guide him |
| 379 |
+through these last phases. |
| 380 |
</p> |
| 381 |
|
| 382 |
<p> |
| 383 |
The quality of the contributions are in this phase most important - every patch |
| 384 |
that does not follow the Documentation Policy, Coding Style or other guideline |
| 385 |
-that affects the document is refused. |
| 386 |
+that affects the document is tackled by the recruit himself with help of the |
| 387 |
+mentor. |
| 388 |
</p> |
| 389 |
|
| 390 |
<p> |
| 391 |
-During this period, you: |
| 392 |
+During this period, the recruit: |
| 393 |
</p> |
| 394 |
|
| 395 |
<ul> |
| 396 |
<li> |
| 397 |
- are advised to learn about Gentoo's inner workings. |
| 398 |
- This is required as you will be asked later on to answer Gentoo's <uri |
| 399 |
+ is advised to learn about Gentoo's inner workings. |
| 400 |
+ This is required as he or she will be asked later on to answer Gentoo's <uri |
| 401 |
link="/proj/en/devrel/quiz/staff-quiz.txt">Staffing Quiz</uri>. |
| 402 |
</li> |
| 403 |
<li> |
| 404 |
will be asked to fill in the <uri |
| 405 |
link="/proj/en/gdp/doc/doc-quiz.xml">Gentoo Documentation Project |
| 406 |
- Quiz</uri>. You need to successfully pass this entire quiz (all questions) |
| 407 |
- before you can continue with the next Phase. |
| 408 |
+ Quiz</uri>. He or she needs to successfully pass this entire quiz |
| 409 |
+ (all questions) before we can continue with the next Phase. |
| 410 |
</li> |
| 411 |
</ul> |
| 412 |
|
| 413 |
@@ -531,10 +420,23 @@ |
| 414 |
<body> |
| 415 |
|
| 416 |
<p> |
| 417 |
-When Phase 2 is finished, the Operational Manager will contact <uri |
| 418 |
+When Phase 2 is finished, the project lead will contact <uri |
| 419 |
link="/proj/en/devrel/">Developer Relations</uri> and give a final "Go!" for the |
| 420 |
-Gentoo recruitment process after which you will be given a Gentoo e-mail |
| 421 |
-address and be appointed to one or more subprojects. |
| 422 |
+Gentoo recruitment process after which the recruit will be given access to the |
| 423 |
+necessary Gentoo infrastructural services (like the documentation repository). |
| 424 |
+</p> |
| 425 |
+ |
| 426 |
+</body> |
| 427 |
+</section> |
| 428 |
+<section> |
| 429 |
+<title>Recruitment of Existing Gentoo Developers</title> |
| 430 |
+<body> |
| 431 |
+ |
| 432 |
+<p> |
| 433 |
+If the recruit is already a Gentoo Developer, the same recruitment process is |
| 434 |
+followed, but the staffing quiz is not necessary anymore. However, the <uri |
| 435 |
+link="/proj/en/gdp/doc/doc-quiz.xml">Gentoo Documentation Project Quiz</uri> is |
| 436 |
+still mandatory. |
| 437 |
</p> |
| 438 |
|
| 439 |
</body> |
Archives