neysx 06/07/08 17:21:18 Modified: doc-policy.xml Log: s/spyderous/dberkholz/
Revision Changes Path 1.21 xml/htdocs/proj/en/gdp/doc/doc-policy.xml 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 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 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 Index: doc-policy.xml =================================================================== RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-policy.xml,v retrieving revision 1.20 retrieving revision 1.21 diff -u -r1.20 -r1.21 --- doc-policy.xml 22 Dec 2005 22:24:11 -0000 1.20 +++ doc-policy.xml 8 Jul 2006 17:21:18 -0000 1.21 @@ -1,18 +1,18 @@ <?xml version='1.0' encoding="UTF-8"?> -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-policy.xml,v 1.20 2005/12/22 22:24:11 neysx Exp $ --> +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-policy.xml,v 1.21 2006/07/08 17:21:18 neysx Exp $ --> <!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> <guide link="doc-policy.xml"> <title>Gentoo Linux Documentation Policy</title> <author title="Author"> - <mail link="[EMAIL PROTECTED]">John P. Davis</mail> + <mail link="[EMAIL PROTECTED]">John P. Davis</mail> </author> <author title="Author"> - <mail link="[EMAIL PROTECTED]">Sven Vermeulen</mail> + <mail link="[EMAIL PROTECTED]">Sven Vermeulen</mail> </author> <author title="Editor"> - <mail link="[EMAIL PROTECTED]">Donnie Berkholz</mail> + <mail link="[EMAIL PROTECTED]">Donnie Berkholz</mail> </author> <!-- The content of this document is licensed under the CC-BY-SA license --> @@ -36,9 +36,9 @@ <body> <p> -The Gentoo Linux Documentation team aspires to create exceptionally -professional documentation that is immediately clear and concise to the -end user. In order to fulfill this goal, we have very specific rules and +The Gentoo Linux Documentation team aspires to create exceptionally +professional documentation that is immediately clear and concise to the +end user. In order to fulfill this goal, we have very specific rules and guidelines that <e>all</e> documentation must go through prior to dissemination on our website, or elsewhere. </p> @@ -50,7 +50,7 @@ <body> <p> -This policy will cover the following topics: +This policy will cover the following topics: </p> <ul> @@ -71,7 +71,7 @@ <p> The Gentoo Documentation Project Team is split into several smaller teams -that work in tandem with each other. Each smaller team represents an active +that work in tandem with each other. Each smaller team represents an active development team of a Gentoo Documentation Subproject. </p> @@ -114,7 +114,7 @@ </table> <p> -Every subproject has a Strategic Manager of its own, and may have an +Every subproject has a Strategic Manager of its own, and may have an Operational Manager if deemed appropriate. His responsibilities to the Gentoo Documentation Project (GDP) are listed in the <e>Manager responsibilities</e> section of the <uri @@ -124,12 +124,12 @@ <p> Every subproject of the Gentoo Documentation Team is listed on the -<uri link="/proj/en/gdp/">GDP Webpage</uri>, along with their respective +<uri link="/proj/en/gdp/">GDP Webpage</uri>, along with their respective Strategic Managers. </p> <p> -The decision on adding a subproject is in the hands of the Strategic Manager. +The decision on adding a subproject is in the hands of the Strategic Manager. </p> </body> @@ -158,11 +158,11 @@ <p> Members of the Gentoo Documentation Team should be available at <c>#gentoo-doc</c> on <uri link="http://www.freenode.net";>irc.freenode.net</uri> -whenever they are online. +whenever they are online. </p> <p> -Depending on the assignment or responsibilities, a member may have limited CVS +Depending on the assignment or responsibilities, a member may have limited CVS access to <c>cvs.gentoo.org</c>. Full CVS access is restricted to Gentoo Developers. Read-only CVS access may be granted to recruits. </p> @@ -175,17 +175,17 @@ <p> Every language should be backed up by an official Translation Team. This -team is led by a <e>Lead Translator</e> and perhaps a <e>Follow-On Lead -Translator</e>, who both have CVS commit access. If for any reason the -<e>Lead Translator</e> cannot perform his duties, the <e>Follow-On Lead -Translator</e> is in charge. If the <e>Follow-On</e> is unavailable, the +team is led by a <e>Lead Translator</e> and perhaps a <e>Follow-On Lead +Translator</e>, who both have CVS commit access. If for any reason the +<e>Lead Translator</e> cannot perform his duties, the <e>Follow-On Lead +Translator</e> is in charge. If the <e>Follow-On</e> is unavailable, the mentor(s) is/are in charge of the language. </p> <p> If a translated document for an unsupported language is contributed, the Gentoo -Documentation Team will not publish it officially. Such documents shall not be -linked to the website until an official Translation Team of that language is +Documentation Team will not publish it officially. Such documents shall not be +linked to the website until an official Translation Team of that language is formed. </p> @@ -198,9 +198,9 @@ </p> <p> -For more information Gentoo document translations, please consult the +For more information Gentoo document translations, please consult the <uri link="/proj/en/gdp/doc/translators-howto.xml"> -Translators Howto for Gentoo Documentation</uri> and the +Translators Howto for Gentoo Documentation</uri> and the <uri link="/proj/en/gdp/international.xml"> GDP Internationalisation Subproject</uri> page. </p> @@ -217,9 +217,9 @@ <p> Every document published by the Gentoo Documentation Project must be -licensed by the <uri -link="http://creativecommons.org/licenses/by-sa/2.5/";>Creative Commons -Attribution-ShareAlike License</uri>. +licensed by the <uri +link="http://creativecommons.org/licenses/by-sa/2.5/";>Creative Commons +Attribution-ShareAlike License</uri>. </p> <p> @@ -246,10 +246,10 @@ <p> Every bug reported on <uri link="http://bugs.gentoo.org";>bugs.gentoo.org</uri> -should be handled as fast as possible. If a bug cannot be handled +should be handled as fast as possible. If a bug cannot be handled in a timely fashion, the reporter of that bug should be informed about -this using a comment on the bug, and the bug should be registered in the -<uri link="/proj/en/gdp/doc/metadoc-guide.xml">metadoc.xml</uri> file, if +this using a comment on the bug, and the bug should be registered in the +<uri link="/proj/en/gdp/doc/metadoc-guide.xml">metadoc.xml</uri> file, if applicable. The Strategic or Operational Manager may decide that a bug has a higher priority and should be addressed ahead any other task the assignee is responsible for. @@ -271,20 +271,20 @@ <p> Every Gentoo Documentation Team may handle documentation development as it sees -fit. However, when the document is finished, it should be transformed into -<uri link="/doc/en/xml-guide.xml">GuideXML</uri> and made available on the +fit. However, when the document is finished, it should be transformed into +<uri link="/doc/en/xml-guide.xml">GuideXML</uri> and made available on the Gentoo CVS infrastructure. It must also be registered in the <uri link="/proj/en/gdp/doc/metadoc-guide.xml">metadoc.xml</uri> file if applicable. </p> <p> -When a new document is started or a big change is needed, a bug should be filed +When a new document is started or a big change is needed, a bug should be filed at <uri link="http://bugs.gentoo.org";>bugs.gentoo.org</uri> concerning the development of this document. If there is already a bug in the database that requests a change to the documentation, a new bug does not have to be filed. Grammatical, syntactical or small changes -do not require a bug to be filed on <uri +do not require a bug to be filed on <uri link="http://bugs.gentoo.org";>bugs.gentoo.org</uri> as well. </p> @@ -296,7 +296,7 @@ </p> <p> -All changes in XML formatting should lead to version (and date) bumps only in +All changes in XML formatting should lead to version (and date) bumps only in case the layout of the document changes. </p> @@ -321,7 +321,7 @@ To maintain a high-paced documentation development cycle, technical or intrusive changes to documents can be propagated immediately to the document. This is allowed only <e>if</e> the editor is absolutely confident the changes -are functional. If you are not absolutely confident (for instance because a +are functional. If you are not absolutely confident (for instance because a user has told you how to fix it but you cannot verify yourself), have the changes reviewed by a Gentoo Developer that can verify the changes are apt. </p> @@ -340,7 +340,7 @@ <p> If the document in question is a translation, the <e>Lead Translator</e> of the -affected language is responsible for the document. Only the +affected language is responsible for the document. Only the <e>Lead Translator</e> may commit the document to the CVS repository. However, if the <e>Lead Translator</e> is currently "in training", the trainee's mentor should commit the changes. @@ -390,7 +390,7 @@ Everyone interested in contributing documentation, editing existing documentation, writing new documentation or translating documentation is welcome to join the team. There are no rules or strings attached to -this. Just make sure you are subscribed to <c>[email protected]</c>, +this. Just make sure you are subscribed to <c>[email protected]</c>, and you have fully read this policy and understand it. </p> @@ -425,8 +425,8 @@ <p> No recruitment process starts without investigating the contributions done already to the Gentoo Documentation Project. The number of contributions must be -large to assure a good knowledge of GuideXML, Coding Style and policy. The -contribution period must be large as well to inform the contributor about the +large to assure a good knowledge of GuideXML, Coding Style and policy. The +contribution period must be large as well to inform the contributor about the time-consuming position and pressure the application involves. </p> @@ -477,9 +477,9 @@ </p> <p> -If you feel that you have shown sufficient amount of contributions, contact +If you feel that you have shown sufficient amount of contributions, contact the Operational Manager of the Gentoo Documentation Project. He -will ask you for your coordinates and other information, and then arrange +will ask you for your coordinates and other information, and then arrange for the next phase to be started. </p> @@ -511,12 +511,12 @@ <ul> <li> - are advised to learn about Gentoo's inner workings. + are advised to learn about Gentoo's inner workings. This is required as you will be asked later on to answer Gentoo's <uri link="/proj/en/devrel/quiz/staff-quiz.txt">Staffing Quiz</uri>. </li> <li> - will be asked to fill in the <uri + will be asked to fill in the <uri link="/proj/en/gdp/doc/doc-quiz.xml">Gentoo Documentation Project Quiz</uri>. You need to successfully pass this entire quiz (all questions) before you can continue with the next Phase. @@ -532,8 +532,8 @@ <p> When Phase 2 is finished, the Operational Manager will contact <uri link="/proj/en/devrel">Developer Relations</uri> and give a final "Go!" for the -Gentoo recruitment process after which you will be given a Gentoo e-mail -address and be appointed to one or more subprojects. +Gentoo recruitment process after which you will be given a Gentoo e-mail +address and be appointed to one or more subprojects. </p> </body> -- [email protected] mailing list
