Gentoo Archives: gentoo-doc

From: Joshua Saddler <nightmorph@g.o>
To: gentoo-doc@l.g.o
Subject: Re: [gentoo-doc] Review of Documentation Policy
Date: Thu, 25 Aug 2011 05:41:34
Message-Id: 20110824224101.31ce8638@angelstorm
In Reply to: Re: [gentoo-doc] Review of Documentation Policy by Matt Turner
1 On Tue, 23 Aug 2011 09:43:51 -0400
2 Matt Turner <mattst88@g.o> wrote:
3
4 > On Tue, Aug 23, 2011 at 4:52 AM, Sven Vermeulen <swift@g.o>
5 > wrote:
6 > > On Mon, Aug 22, 2011 at 08:16:59PM -0400, Matt Turner wrote:
7 > >> The information on this page is very irrelevant and confusing to
8 > >> me, as a developer.
9 > >>
10 > >> I don't know how many non-developer documenters we have. I don't
11 > >> know what needs to happen to that text itself, but a section
12 > >> about how current developers join the documentation team is
13 > >> important. Looking at the page, a person must complete the staff
14 > >> and doc quizzes. For a developer, it seems that the requirements
15 > >> should simply be 1) to have become a developer and 2) completed
16 > >> the doc quiz.
17 > >
18 > > Documentation developers are also developers, but they do not
19 > > need to be an ebuild-developer. If I look at the GDP current
20 > > staffing, there are 8 developers that are also ebuild developers
21 > > (or infrastructure or another function within Gentoo) and 11
22 > > developers on the documentation (and translations) only.
23 > >
24 > > Requiring documentation developers to also take the ebuild and
25 > > end quiz would be overshooting, as that is not something they
26 > > require.
27 > >
28 > > Wkr,
29 > >        Sven Vermeulen
30 >
31 > Right, I'm saying for people who are already developers, they should
32 > really only have to complete the doc quiz.
33 >
34 > Matt
35 >
36
37 You want to contribute ebuilds, you have to go through a process that
38 teaches you what you need to know, and shows your mentor that know
39 what you're doing; that you're not going to screw up everyone's
40 boxes.
41
42 You want to write documentation, you have to go through a process
43 that teaches you what you need to know, and shows your mentor that
44 you know what you're doing; that you're not going to screw up
45 everyone's boxes ... *or the Gentoo websites*. (via bad commits that
46 break layouts, links, XML, CSS, etc.)
47
48 Everyone has to go through a process when wanting to join a team.
49 What's so hard about this? Why should ebuild developers get a free
50 pass to get write access? Over the years, I've talked with several
51 different ebuild team leads, as I was interested in what it took to
52 get access to gentoo-x86. There's no free pass for longtime doc
53 writers, either, even those that have run their own private overlay
54 for a long time. I don't just take the ebuild quiz and get commit
55 access. There's a process that I have to go through, too.
56
57 Maybe I'm just reading this wrong, but it sounds like you want to set
58 things up so that anyone who wants to change a doc can overwrite it
59 directly. That's fine for stuff in /proj/ -- the GDP doesn't care
60 about that; documents in /proj/ are solely the responsibility of those
61 projects. And that's why, overall, the quality of stuff in /proj/ is
62 not as good as what's in /doc/.

Attachments

File name MIME type
signature.asc application/pgp-signature

Replies

Subject Author
Re: [gentoo-doc] Review of Documentation Policy Matt Turner <mattst88@g.o>