Linux Archive

Linux Archive (http://www.linux-archive.org/)
-   Gentoo Documentation (http://www.linux-archive.org/gentoo-documentation/)
-   -   GDP policy updates (http://www.linux-archive.org/gentoo-documentation/712939-gdp-policy-updates.html)

Sven Vermeulen 03-20-2013 04:13 PM

GDP policy updates
 
Hi guys,

I'd like to suggest a few changes on our GDP policy, namely:

- updating the license comment if you use a different license should be
mandatory (hence switch from "should" to "must")

Reason: I think this is a "typo" as "must" fits more in the idea of that
paragraph.

- drop using metadoc.xml for registering long outstanding bugs

Reason: it was a nice idea, but never truely used

- have project lead (or delegated person) "decide" on the recruitment
process / progress

Reason: we already dropped the time frame windows in the past, but wasn't
really clear who then decides that a phase can go through or not. So make
it explicit that it is the lead (or a delegated person)

- drop mandatory gdp quiz, make it recommended

Reason: we already have a contribution period where the recruit sends in
contributions or patches; the knowledge on the GuideXML, as far as needed
for the tasks the recruit wants to do, should be apparent from the
contributions.

The quiz requires more knowledge than we might expect from most
documentation developers (not in the past, but given the resources at hand
right now, it makes sense to remove the mandatory requirement).

Below is the suggested change on the policy.

Comments are of course welcome (otherwise I wouldn't mail to the mailinglist
:-P)

Wkr,
Sven Vermeulen


Index: doc-policy.xml
================================================== =================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-policy.xml,v
retrieving revision 1.27
diff -u -B -r1.27 doc-policy.xml
--- doc-policy.xml 29 Nov 2011 19:01:23 -0000 1.27
+++ doc-policy.xml 20 Mar 2013 17:04:40 -0000
@@ -186,7 +186,7 @@

<p>
If the 2.5 version is used, the tag can be either <c>&lt;license /&gt;</c> or
-<c>&lt;license version="2.5" /&gt;</c>. In either case should the comment be
+<c>&lt;license version="2.5" /&gt;</c>. In either case must the comment be
updated to refer to the correct version URL.
</p>

@@ -200,9 +200,7 @@
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
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
-applicable.
+this using a comment on the bug.
</p>

<p>
@@ -377,9 +375,10 @@

<p>
If you feel that you have shown sufficient amount of contributions, contact
-the project lead of the Gentoo Documentation Project. He will ask you for your
-coordinates and other information, and then arrange for the next phase to be
-started.
+the project lead of the Gentoo Documentation Project who will review the
+contributions and the timeframe (or delegate this towards another GDP member).
+He will ask you for your coordinates and other information, and
+then arrange for the next phase to be started.
</p>

</body>
@@ -403,22 +402,20 @@
</p>

<p>
-During this period, the recruit:
+During this period, the recruit: is advised to learn about Gentoo's inner workings.
+This is required as he or she will be asked later on to answer Gentoo's <uri
+link="/proj/en/devrel/quiz/staff-quiz.txt">Staffing Quiz</uri>.
</p>

-<ul>
- <li>
- is advised to learn about Gentoo's inner workings.
- This is required as he or she 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
- link="/proj/en/gdp/doc/doc-quiz.xml">Gentoo Documentation Project
- Quiz</uri>. He or she needs to successfully pass this entire quiz
- (all questions) before we can continue with the next Phase.
- </li>
-</ul>
+<p>
+It is also recommended, but not automatically required, to fill in the <uri
+link="/proj/en/gdp/doc/doc-quiz.xml">Gentoo Documentation Project Quiz</uri>.
+This will assist the recruit in learning more about how the Gentoo Documentation
+Project documentation works. If at a later time the Gentoo Documentation Project
+lead feels that the recruit (or by then editor or author) shows insufficient
+knowledge on this, he might ask the recruit (or by then editor or author) to
+work on the quiz after all.
+</p>

</body>
</section>
@@ -441,9 +438,9 @@

<p>
If the recruit is already a Gentoo Developer, the same recruitment process is
-followed, but the staffing quiz is not necessary anymore. However, the <uri
+followed, but of course the staffing quiz is not necessary anymore. The <uri
link="/proj/en/gdp/doc/doc-quiz.xml">Gentoo Documentation Project Quiz</uri> is
-still mandatory.
+still recommended.
</p>

</body>

Tobias Heinlein 03-20-2013 05:17 PM

GDP policy updates
 
Looks great!

+1

Regards,
Tobias

On 20.03.2013 18:13, Sven Vermeulen wrote:

Hi guys,

I'd like to suggest a few changes on our GDP policy, namely:

- updating the license comment if you use a different license should be
mandatory (hence switch from "should" to "must")

Reason: I think this is a "typo" as "must" fits more in the idea of that
paragraph.

- drop using metadoc.xml for registering long outstanding bugs

Reason: it was a nice idea, but never truely used

- have project lead (or delegated person) "decide" on the recruitment
process / progress

Reason: we already dropped the time frame windows in the past, but wasn't
really clear who then decides that a phase can go through or not. So make
it explicit that it is the lead (or a delegated person)

- drop mandatory gdp quiz, make it recommended

Reason: we already have a contribution period where the recruit sends in
contributions or patches; the knowledge on the GuideXML, as far as needed
for the tasks the recruit wants to do, should be apparent from the
contributions.

The quiz requires more knowledge than we might expect from most
documentation developers (not in the past, but given the resources at hand
right now, it makes sense to remove the mandatory requirement).

Below is the suggested change on the policy.

Comments are of course welcome (otherwise I wouldn't mail to the mailinglist
:-P)

Wkr,
Sven Vermeulen


Index: doc-policy.xml
================================================== =================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-policy.xml,v
retrieving revision 1.27
diff -u -B -r1.27 doc-policy.xml
--- doc-policy.xml 29 Nov 2011 19:01:23 -0000 1.27
+++ doc-policy.xml 20 Mar 2013 17:04:40 -0000
@@ -186,7 +186,7 @@

<p>
If the 2.5 version is used, the tag can be either <c>&lt;license /&gt;</c> or
-<c>&lt;license version="2.5" /&gt;</c>. In either case should the comment be
+<c>&lt;license version="2.5" /&gt;</c>. In either case must the comment be
updated to refer to the correct version URL.
</p>

@@ -200,9 +200,7 @@
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
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
-applicable.
+this using a comment on the bug.
</p>

<p>
@@ -377,9 +375,10 @@

<p>
If you feel that you have shown sufficient amount of contributions, contact
-the project lead of the Gentoo Documentation Project. He will ask you for your
-coordinates and other information, and then arrange for the next phase to be
-started.
+the project lead of the Gentoo Documentation Project who will review the
+contributions and the timeframe (or delegate this towards another GDP member).
+He will ask you for your coordinates and other information, and
+then arrange for the next phase to be started.
</p>

</body>
@@ -403,22 +402,20 @@
</p>

<p>
-During this period, the recruit:
+During this period, the recruit: is advised to learn about Gentoo's inner workings.
+This is required as he or she will be asked later on to answer Gentoo's <uri
+link="/proj/en/devrel/quiz/staff-quiz.txt">Staffing Quiz</uri>.
</p>

-<ul>
- <li>
- is advised to learn about Gentoo's inner workings.
- This is required as he or she 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
- link="/proj/en/gdp/doc/doc-quiz.xml">Gentoo Documentation Project
- Quiz</uri>. He or she needs to successfully pass this entire quiz
- (all questions) before we can continue with the next Phase.
- </li>
-</ul>
+<p>
+It is also recommended, but not automatically required, to fill in the <uri
+link="/proj/en/gdp/doc/doc-quiz.xml">Gentoo Documentation Project Quiz</uri>.
+This will assist the recruit in learning more about how the Gentoo Documentation
+Project documentation works. If at a later time the Gentoo Documentation Project
+lead feels that the recruit (or by then editor or author) shows insufficient
+knowledge on this, he might ask the recruit (or by then editor or author) to
+work on the quiz after all.
+</p>

</body>
</section>
@@ -441,9 +438,9 @@

<p>
If the recruit is already a Gentoo Developer, the same recruitment process is
-followed, but the staffing quiz is not necessary anymore. However, the <uri
+followed, but of course the staffing quiz is not necessary anymore. The <uri
link="/proj/en/gdp/doc/doc-quiz.xml">Gentoo Documentation Project Quiz</uri> is
-still mandatory.
+still recommended.
</p>

</body>

Chema Alonso 03-21-2013 05:13 PM

GDP policy updates
 
On Wed, Mar 20, 2013 at 05:13:01PM +0000, Sven Vermeulen wrote:
> Hi guys,
>
> I'd like to suggest a few changes on our GDP policy, namely:
>
...
>

Sounds good, +1 here.

Regards.

Joshua Saddler 03-21-2013 10:26 PM

GDP policy updates
 
On Wed, 20 Mar 2013 17:13:01 +0000
Sven Vermeulen <swift@gentoo.org> wrote:

> I'd like to suggest a few changes on our GDP policy, namely:
>
> - updating the license comment if you use a different license should be
> mandatory (hence switch from "should" to "must")

approved.

> - drop using metadoc.xml for registering long outstanding bugs

approved. i'd forgotten that was even setup that way. we haven't used it like that in years.

> - have project lead (or delegated person) "decide" on the recruitment
> process / progress

approved. especially since i'm away quite a bit these days with health issues -- i read everything sent in to bugzie and the lists, but am unable to do much activity-wise. more than one designated contact, and a streamlined recruitment, is a good idea.

(i volunteer you, if you're willing. :) )

> - drop mandatory gdp quiz, make it recommended

approved, tentatively. we need to be careful going forward to make sure that folks at least know the basics of GDP so they don't break the tree (and/or their translations). the point of the quiz is to make sure that everyone is "on the same page" so that we don't have wildly different code styles, broken code, or lacking knowledge on how to do "stuff."

we can keep an eye on potential new recruits without the up-front strict requirements; make sure they know what they're doing. we do already have guidelines in place for translations for example, where we do as-is or reject-all for proxy commits, so...this new way of doing it could fit right in. though a revised quiz might not be a bad idea.

as it is, i've caught a lot of errors on every quiz i've reviewed, so it is good that folks get their misconceptions corrected early in the process, so they spend more time writing good code, and less re-writing bad.


thanks again for your extensive review and suggestions, sven! (and for inadvertently giving me a needed kick-in-the-pants.) i'm in favor of making all these changes happen.


All times are GMT. The time now is 04:34 PM.

VBulletin, Copyright ©2000 - 2014, Jelsoft Enterprises Ltd.
Content Relevant URLs by vBSEO ©2007, Crawlability, Inc.