| 1 |
neysx 06/07/08 17:21:18 |
| 2 |
|
| 3 |
Modified: doc-policy.xml |
| 4 |
Log: |
| 5 |
s/spyderous/dberkholz/ |
| 6 |
|
| 7 |
Revision Changes Path |
| 8 |
1.21 xml/htdocs/proj/en/gdp/doc/doc-policy.xml |
| 9 |
|
| 10 |
file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-policy.xml?rev=1.21&content-type=text/x-cvsweb-markup&cvsroot=gentoo |
| 11 |
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-policy.xml?rev=1.21&content-type=text/plain&cvsroot=gentoo |
| 12 |
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/gdp/doc/doc-policy.xml.diff?r1=1.20&r2=1.21&cvsroot=gentoo |
| 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.20 |
| 18 |
retrieving revision 1.21 |
| 19 |
diff -u -r1.20 -r1.21 |
| 20 |
--- doc-policy.xml 22 Dec 2005 22:24:11 -0000 1.20 |
| 21 |
+++ doc-policy.xml 8 Jul 2006 17:21:18 -0000 1.21 |
| 22 |
@@ -1,18 +1,18 @@ |
| 23 |
<?xml version='1.0' encoding="UTF-8"?> |
| 24 |
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-policy.xml,v 1.20 2005/12/22 22:24:11 neysx Exp $ --> |
| 25 |
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-policy.xml,v 1.21 2006/07/08 17:21:18 neysx Exp $ --> |
| 26 |
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> |
| 27 |
|
| 28 |
<guide link="doc-policy.xml"> |
| 29 |
|
| 30 |
<title>Gentoo Linux Documentation Policy</title> |
| 31 |
<author title="Author"> |
| 32 |
- <mail link="zhen@g.o">John P. Davis</mail> |
| 33 |
+ <mail link="zhen@g.o">John P. Davis</mail> |
| 34 |
</author> |
| 35 |
<author title="Author"> |
| 36 |
- <mail link="swift@g.o">Sven Vermeulen</mail> |
| 37 |
+ <mail link="swift@g.o">Sven Vermeulen</mail> |
| 38 |
</author> |
| 39 |
<author title="Editor"> |
| 40 |
- <mail link="spyderous@g.o">Donnie Berkholz</mail> |
| 41 |
+ <mail link="dberkholz@g.o">Donnie Berkholz</mail> |
| 42 |
</author> |
| 43 |
|
| 44 |
<!-- The content of this document is licensed under the CC-BY-SA license --> |
| 45 |
@@ -36,9 +36,9 @@ |
| 46 |
<body> |
| 47 |
|
| 48 |
<p> |
| 49 |
-The Gentoo Linux Documentation team aspires to create exceptionally |
| 50 |
-professional documentation that is immediately clear and concise to the |
| 51 |
-end user. In order to fulfill this goal, we have very specific rules and |
| 52 |
+The Gentoo Linux Documentation team aspires to create exceptionally |
| 53 |
+professional documentation that is immediately clear and concise to the |
| 54 |
+end user. In order to fulfill this goal, we have very specific rules and |
| 55 |
guidelines that <e>all</e> documentation must go through prior to |
| 56 |
dissemination on our website, or elsewhere. |
| 57 |
</p> |
| 58 |
@@ -50,7 +50,7 @@ |
| 59 |
<body> |
| 60 |
|
| 61 |
<p> |
| 62 |
-This policy will cover the following topics: |
| 63 |
+This policy will cover the following topics: |
| 64 |
</p> |
| 65 |
|
| 66 |
<ul> |
| 67 |
@@ -71,7 +71,7 @@ |
| 68 |
|
| 69 |
<p> |
| 70 |
The Gentoo Documentation Project Team is split into several smaller teams |
| 71 |
-that work in tandem with each other. Each smaller team represents an active |
| 72 |
+that work in tandem with each other. Each smaller team represents an active |
| 73 |
development team of a Gentoo Documentation Subproject. |
| 74 |
</p> |
| 75 |
|
| 76 |
@@ -114,7 +114,7 @@ |
| 77 |
</table> |
| 78 |
|
| 79 |
<p> |
| 80 |
-Every subproject has a Strategic Manager of its own, and may have an |
| 81 |
+Every subproject has a Strategic Manager of its own, and may have an |
| 82 |
Operational Manager if deemed appropriate. His responsibilities to the Gentoo |
| 83 |
Documentation Project (GDP) are listed in the <e>Manager responsibilities</e> |
| 84 |
section of the <uri |
| 85 |
@@ -124,12 +124,12 @@ |
| 86 |
|
| 87 |
<p> |
| 88 |
Every subproject of the Gentoo Documentation Team is listed on the |
| 89 |
-<uri link="/proj/en/gdp/">GDP Webpage</uri>, along with their respective |
| 90 |
+<uri link="/proj/en/gdp/">GDP Webpage</uri>, along with their respective |
| 91 |
Strategic Managers. |
| 92 |
</p> |
| 93 |
|
| 94 |
<p> |
| 95 |
-The decision on adding a subproject is in the hands of the Strategic Manager. |
| 96 |
+The decision on adding a subproject is in the hands of the Strategic Manager. |
| 97 |
</p> |
| 98 |
|
| 99 |
</body> |
| 100 |
@@ -158,11 +158,11 @@ |
| 101 |
<p> |
| 102 |
Members of the Gentoo Documentation Team should be available at |
| 103 |
<c>#gentoo-doc</c> on <uri link="http://www.freenode.net">irc.freenode.net</uri> |
| 104 |
-whenever they are online. |
| 105 |
+whenever they are online. |
| 106 |
</p> |
| 107 |
|
| 108 |
<p> |
| 109 |
-Depending on the assignment or responsibilities, a member may have limited CVS |
| 110 |
+Depending on the assignment or responsibilities, a member may have limited CVS |
| 111 |
access to <c>cvs.gentoo.org</c>. Full CVS access is restricted to Gentoo |
| 112 |
Developers. Read-only CVS access may be granted to recruits. |
| 113 |
</p> |
| 114 |
@@ -175,17 +175,17 @@ |
| 115 |
|
| 116 |
<p> |
| 117 |
Every language should be backed up by an official Translation Team. This |
| 118 |
-team is led by a <e>Lead Translator</e> and perhaps a <e>Follow-On Lead |
| 119 |
-Translator</e>, who both have CVS commit access. If for any reason the |
| 120 |
-<e>Lead Translator</e> cannot perform his duties, the <e>Follow-On Lead |
| 121 |
-Translator</e> is in charge. If the <e>Follow-On</e> is unavailable, the |
| 122 |
+team is led by a <e>Lead Translator</e> and perhaps a <e>Follow-On Lead |
| 123 |
+Translator</e>, who both have CVS commit access. If for any reason the |
| 124 |
+<e>Lead Translator</e> cannot perform his duties, the <e>Follow-On Lead |
| 125 |
+Translator</e> is in charge. If the <e>Follow-On</e> is unavailable, the |
| 126 |
mentor(s) is/are in charge of the language. |
| 127 |
</p> |
| 128 |
|
| 129 |
<p> |
| 130 |
If a translated document for an unsupported language is contributed, the Gentoo |
| 131 |
-Documentation Team will not publish it officially. Such documents shall not be |
| 132 |
-linked to the website until an official Translation Team of that language is |
| 133 |
+Documentation Team will not publish it officially. Such documents shall not be |
| 134 |
+linked to the website until an official Translation Team of that language is |
| 135 |
formed. |
| 136 |
</p> |
| 137 |
|
| 138 |
@@ -198,9 +198,9 @@ |
| 139 |
</p> |
| 140 |
|
| 141 |
<p> |
| 142 |
-For more information Gentoo document translations, please consult the |
| 143 |
+For more information Gentoo document translations, please consult the |
| 144 |
<uri link="/proj/en/gdp/doc/translators-howto.xml"> |
| 145 |
-Translators Howto for Gentoo Documentation</uri> and the |
| 146 |
+Translators Howto for Gentoo Documentation</uri> and the |
| 147 |
<uri link="/proj/en/gdp/international.xml"> |
| 148 |
GDP Internationalisation Subproject</uri> page. |
| 149 |
</p> |
| 150 |
@@ -217,9 +217,9 @@ |
| 151 |
|
| 152 |
<p> |
| 153 |
Every document published by the Gentoo Documentation Project must be |
| 154 |
-licensed by the <uri |
| 155 |
-link="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons |
| 156 |
-Attribution-ShareAlike License</uri>. |
| 157 |
+licensed by the <uri |
| 158 |
+link="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons |
| 159 |
+Attribution-ShareAlike License</uri>. |
| 160 |
</p> |
| 161 |
|
| 162 |
<p> |
| 163 |
@@ -246,10 +246,10 @@ |
| 164 |
|
| 165 |
<p> |
| 166 |
Every bug reported on <uri link="http://bugs.gentoo.org">bugs.gentoo.org</uri> |
| 167 |
-should be handled as fast as possible. If a bug cannot be handled |
| 168 |
+should be handled as fast as possible. If a bug cannot be handled |
| 169 |
in a timely fashion, the reporter of that bug should be informed about |
| 170 |
-this using a comment on the bug, and the bug should be registered in the |
| 171 |
-<uri link="/proj/en/gdp/doc/metadoc-guide.xml">metadoc.xml</uri> file, if |
| 172 |
+this using a comment on the bug, and the bug should be registered in the |
| 173 |
+<uri link="/proj/en/gdp/doc/metadoc-guide.xml">metadoc.xml</uri> file, if |
| 174 |
applicable. The Strategic or Operational Manager may decide that a bug has a |
| 175 |
higher priority and should be addressed ahead any other task the assignee |
| 176 |
is responsible for. |
| 177 |
@@ -271,20 +271,20 @@ |
| 178 |
|
| 179 |
<p> |
| 180 |
Every Gentoo Documentation Team may handle documentation development as it sees |
| 181 |
-fit. However, when the document is finished, it should be transformed into |
| 182 |
-<uri link="/doc/en/xml-guide.xml">GuideXML</uri> and made available on the |
| 183 |
+fit. However, when the document is finished, it should be transformed into |
| 184 |
+<uri link="/doc/en/xml-guide.xml">GuideXML</uri> and made available on the |
| 185 |
Gentoo CVS infrastructure. It must also be registered in the |
| 186 |
<uri link="/proj/en/gdp/doc/metadoc-guide.xml">metadoc.xml</uri> file if |
| 187 |
applicable. |
| 188 |
</p> |
| 189 |
|
| 190 |
<p> |
| 191 |
-When a new document is started or a big change is needed, a bug should be filed |
| 192 |
+When a new document is started or a big change is needed, a bug should be filed |
| 193 |
at <uri link="http://bugs.gentoo.org">bugs.gentoo.org</uri> |
| 194 |
concerning the development of this document. If there is already a bug |
| 195 |
in the database that requests a change to the documentation, a new bug |
| 196 |
does not have to be filed. Grammatical, syntactical or small changes |
| 197 |
-do not require a bug to be filed on <uri |
| 198 |
+do not require a bug to be filed on <uri |
| 199 |
link="http://bugs.gentoo.org">bugs.gentoo.org</uri> as well. |
| 200 |
</p> |
| 201 |
|
| 202 |
@@ -296,7 +296,7 @@ |
| 203 |
</p> |
| 204 |
|
| 205 |
<p> |
| 206 |
-All changes in XML formatting should lead to version (and date) bumps only in |
| 207 |
+All changes in XML formatting should lead to version (and date) bumps only in |
| 208 |
case the layout of the document changes. |
| 209 |
</p> |
| 210 |
|
| 211 |
@@ -321,7 +321,7 @@ |
| 212 |
To maintain a high-paced documentation development cycle, technical or |
| 213 |
intrusive changes to documents can be propagated immediately to the document. |
| 214 |
This is allowed only <e>if</e> the editor is absolutely confident the changes |
| 215 |
-are functional. If you are not absolutely confident (for instance because a |
| 216 |
+are functional. If you are not absolutely confident (for instance because a |
| 217 |
user has told you how to fix it but you cannot verify yourself), have the |
| 218 |
changes reviewed by a Gentoo Developer that can verify the changes are apt. |
| 219 |
</p> |
| 220 |
@@ -340,7 +340,7 @@ |
| 221 |
|
| 222 |
<p> |
| 223 |
If the document in question is a translation, the <e>Lead Translator</e> of the |
| 224 |
-affected language is responsible for the document. Only the |
| 225 |
+affected language is responsible for the document. Only the |
| 226 |
<e>Lead Translator</e> may commit the document to the CVS repository. However, |
| 227 |
if the <e>Lead Translator</e> is currently "in training", the trainee's mentor |
| 228 |
should commit the changes. |
| 229 |
@@ -390,7 +390,7 @@ |
| 230 |
Everyone interested in contributing documentation, editing existing |
| 231 |
documentation, writing new documentation or translating documentation is |
| 232 |
welcome to join the team. There are no rules or strings attached to |
| 233 |
-this. Just make sure you are subscribed to <c>gentoo-doc@g.o</c>, |
| 234 |
+this. Just make sure you are subscribed to <c>gentoo-doc@g.o</c>, |
| 235 |
and you have fully read this policy and understand it. |
| 236 |
</p> |
| 237 |
|
| 238 |
@@ -425,8 +425,8 @@ |
| 239 |
<p> |
| 240 |
No recruitment process starts without investigating the contributions done |
| 241 |
already to the Gentoo Documentation Project. The number of contributions must be |
| 242 |
-large to assure a good knowledge of GuideXML, Coding Style and policy. The |
| 243 |
-contribution period must be large as well to inform the contributor about the |
| 244 |
+large to assure a good knowledge of GuideXML, Coding Style and policy. The |
| 245 |
+contribution period must be large as well to inform the contributor about the |
| 246 |
time-consuming position and pressure the application involves. |
| 247 |
</p> |
| 248 |
|
| 249 |
@@ -477,9 +477,9 @@ |
| 250 |
</p> |
| 251 |
|
| 252 |
<p> |
| 253 |
-If you feel that you have shown sufficient amount of contributions, contact |
| 254 |
+If you feel that you have shown sufficient amount of contributions, contact |
| 255 |
the Operational Manager of the Gentoo Documentation Project. He |
| 256 |
-will ask you for your coordinates and other information, and then arrange |
| 257 |
+will ask you for your coordinates and other information, and then arrange |
| 258 |
for the next phase to be started. |
| 259 |
</p> |
| 260 |
|
| 261 |
@@ -511,12 +511,12 @@ |
| 262 |
|
| 263 |
<ul> |
| 264 |
<li> |
| 265 |
- are advised to learn about Gentoo's inner workings. |
| 266 |
+ are advised to learn about Gentoo's inner workings. |
| 267 |
This is required as you will be asked later on to answer Gentoo's <uri |
| 268 |
link="/proj/en/devrel/quiz/staff-quiz.txt">Staffing Quiz</uri>. |
| 269 |
</li> |
| 270 |
<li> |
| 271 |
- will be asked to fill in the <uri |
| 272 |
+ will be asked to fill in the <uri |
| 273 |
link="/proj/en/gdp/doc/doc-quiz.xml">Gentoo Documentation Project |
| 274 |
Quiz</uri>. You need to successfully pass this entire quiz (all questions) |
| 275 |
before you can continue with the next Phase. |
| 276 |
@@ -532,8 +532,8 @@ |
| 277 |
<p> |
| 278 |
When Phase 2 is finished, the Operational Manager will contact <uri |
| 279 |
link="/proj/en/devrel">Developer Relations</uri> and give a final "Go!" for the |
| 280 |
-Gentoo recruitment process after which you will be given a Gentoo e-mail |
| 281 |
-address and be appointed to one or more subprojects. |
| 282 |
+Gentoo recruitment process after which you will be given a Gentoo e-mail |
| 283 |
+address and be appointed to one or more subprojects. |
| 284 |
</p> |
| 285 |
|
| 286 |
</body> |
| 287 |
|
| 288 |
|
| 289 |
|
| 290 |
-- |
| 291 |
gentoo-doc-cvs@g.o mailing list |
Archives