1 |
On Thu, Oct 23, 2003 at 01:09:21PM -0400, donnie berkholz wrote: |
2 |
> My understanding of the Project Doc Editor's role is that he has authority |
3 |
> to review and commit changes of docs in that project. Am I |
4 |
> misunderstanding that role? |
5 |
|
6 |
The Project Doc Editor is the developer who will take on bugreports |
7 |
on the documentation of his (or her) project in case technical changes are |
8 |
needed. He is a full member of the documentation team, but doesn't have to do |
9 |
documentation editing for other documents (although he is free to do so). |
10 |
|
11 |
When a patch is created, independent of who made the patch and why, it must |
12 |
be reviewed by a second person (a gentoo developer) to check for |
13 |
inconsistencies, other errors and such. This reviewing step is mandatory |
14 |
unless: |
15 |
- the patch must be applied asap because the current documentation |
16 |
breaks systems |
17 |
- the patch is to fix grammatical issues or typos |
18 |
|
19 |
In some cases, this means a one-man job (if the bugreport already has a |
20 |
patch, then he (or she) can review the patch and commit); in most cases you |
21 |
write up a patch and attach it to the bugreport. One of our editors will then |
22 |
verify the patch and state (as a comment on the bugreport) that the patch is |
23 |
fine (or something with the same meaning :) |
24 |
|
25 |
The documentation team works by the documentation policy [1], although a new |
26 |
change [2] on that policy which removes some difficulties is waiting. |
27 |
|
28 |
Wkr, |
29 |
Sven Vermeulen |
30 |
|
31 |
[1] http://www.gentoo.org/doc/en/doc-policy.xml |
32 |
[2] http://emu.gentoo.org/~swift/doc-policy.html |
33 |
|
34 |
-- |
35 |
^__^ And Larry saw that it was Good. |
36 |
(oo) Sven Vermeulen |
37 |
(__) http://www.gentoo.org Gentoo Documentation Project |