1 |
wireless wrote: |
2 |
> Well this all depends on your viewpoint. If you want a set of |
3 |
> documents, that folks with deep gentoo experience can use, |
4 |
> then stay the coarse. If you (we being the larger gentoo community |
5 |
> including noobs, novices and nerds) then the last date of |
6 |
> checking or updating is fundamentally important. We all know the |
7 |
> internet is full of outdated and erroneous information. |
8 |
|
9 |
I can't parse the third sentence, sorry. Isn't there missing something |
10 |
like "[If you] want us (...) to use it, [then...]"? |
11 |
|
12 |
> I find Camile's points very consistent with what the average user or |
13 |
> noob will need. I would also 'simplify' the process, (see touch below) |
14 |
> So ask yourself who do the documents need |
15 |
> to be focused on, the gentoo elite, or the average gentoo |
16 |
> hack....? |
17 |
|
18 |
Unlike Josh in his original mail, I'm not proposing removal of any |
19 |
information. My reply is related only to the quoted part of cam's mail, |
20 |
a periodic update of the date field alone. The reason is that we have |
21 |
translators who maintain other languages of the same document, and these |
22 |
translators would have to update this "last-modified thing" as well. |
23 |
We're speaking about roughly ten languages right now. So, basically, |
24 |
whenever an English document gets its date updated, you add a task for |
25 |
ten people to do. Even though this can be partially automated (like |
26 |
"update all non-English documents which were up-to-date before the |
27 |
change"), this automation might be misleading to the users, as you'd be |
28 |
essentially marking, say, a German document "reviewed", despite that |
29 |
you, as the one who touched the English doc, can't even read German and |
30 |
therefore have absolutely no idea about correctness of the document |
31 |
translation. |
32 |
|
33 |
In addition, my comment probably makes sense only to the GDP members, as |
34 |
"yoswink" is our Spanish lead translator, who would say "I'll cut off |
35 |
your finger" whenever we touched the English Handbook. |
36 |
|
37 |
> It should not be that hard (internally) to track the last date |
38 |
> the file was touched using 'touch' or whatever mechanism floats |
39 |
> your boat, to provide the average user some comfort as to the |
40 |
> usability, related to the age of the last check for accuracy the |
41 |
> doc has undergone. If we use the last date the doc was 'touch-ed' be one |
42 |
> of the gentoo elite, then the mechanism is simple. Surely this sort of |
43 |
> mechanism would be heralded |
44 |
> as a gentoo point of excellence among a sea of mediocre distros. |
45 |
|
46 |
Well, we already do keep track of changes which are "important enough" |
47 |
to update the date. We're all fine with this. |
48 |
|
49 |
> On another note, I think what is needed is something simple and bold |
50 |
> at the top of the official gentoo docs that clearly let folks know that |
51 |
> the doc is an official gentoo maintained doc. |
52 |
|
53 |
Anything at www.gentoo.org/doc/en/ which isn't explicitly marked with a |
54 |
disclaimer (like "Disclaimer : This document is a work in progress and |
55 |
should not be considered official yet." or "Disclaimer : This document |
56 |
is not valid and is not maintained anymore.") *is* maintained and is |
57 |
supposed to reflect current status of the stable tree. We'd like to |
58 |
receive a bugreport for each error you can find. Anything which is found |
59 |
elsewhere than at www.gentoo.org might or might not be broken. We can't |
60 |
do anything about that, sorry. |
61 |
|
62 |
> If you google for |
63 |
> help you get all sorts of gentoo-ish looking docs and the average |
64 |
> user may not know how to distinguish the official (maintained docs) |
65 |
> from the rest. My thoughts here are some sort of 'gentoo-certified' |
66 |
> symbol that is hyperlinked to a page that delineates (clearly explains) |
67 |
> the nature of the officially maintained docs. Maybe the |
68 |
> symbol could be Dali-ish artistic GC for Gentoo Certified. |
69 |
|
70 |
Er, well, any documentation found anywhere else (like gentoo-wiki.com, |
71 |
some blog sites or whatever) will *never* get this "certification" |
72 |
anyway. We can't support random stuff on the Internet. Anything what is |
73 |
at our webspace is, however, a valid documentation that is supposed to |
74 |
be error-free (unless marked with that disclaimer). |
75 |
|
76 |
You can see samples of these disclaimers at [1] or [2]. |
77 |
|
78 |
Cheers, |
79 |
-jkt |
80 |
|
81 |
[1] http://www.gentoo.org/doc/en/ldap-howto.xml |
82 |
[2] http://www.gentoo.org/doc/en/genkernel.xml |
83 |
|
84 |
-- |
85 |
cd /local/pub && more beer > /dev/mouth |