Re: [gentoo-dev] Documentation linkage or location

[Sven Vermeulen <swift@gentoo.org>]

[-- Attachment #1: Type: text/plain, Size: 1717 bytes --]

On Thu, Oct 23, 2003 at 01:09:21PM -0400, donnie berkholz wrote:
> My understanding of the Project Doc Editor's role is that he has authority
> to review and commit changes of docs in that project. Am I
> misunderstanding that role?

The Project Doc Editor is the developer who will take on bugreports
on the documentation of his (or her) project in case technical changes are
needed. He is a full member of the documentation team, but doesn't have to do
documentation editing for other documents (although he is free to do so).

When a patch is created, independent of who made the patch and why, it must
be reviewed by a second person (a gentoo developer) to check for
inconsistencies, other errors and such. This reviewing step is mandatory
unless:
	- the patch must be applied asap because the current documentation
	  breaks systems
	- the patch is to fix grammatical issues or typos

In some cases, this means a one-man job (if the bugreport already has a
patch, then he (or she) can review the patch and commit); in most cases you
write up a patch and attach it to the bugreport. One of our editors will then
verify the patch and state (as a comment on the bugreport) that the patch is
fine (or something with the same meaning :)

The documentation team works by the documentation policy [1], although a new
change [2] on that policy which removes some difficulties is waiting.

Wkr,
	Sven Vermeulen

[1] http://www.gentoo.org/doc/en/doc-policy.xml
[2] http://emu.gentoo.org/~swift/doc-policy.html

-- 
 ^__^   And Larry saw that it was Good.
 (oo)                                      Sven Vermeulen
 (__)   http://www.gentoo.org              Gentoo Documentation Project

[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]