Gentoo Archives: gentoo-doc

From: AllenJB <gentoo-lists@××××××××××.uk>
To: gentoo-doc@l.g.o
Subject: Re: [gentoo-doc] Wiki, Take #whatever
Date: Tue, 18 Nov 2008 17:26:50
Message-Id: 4922FAD3.5070406@allenjb.me.uk
In Reply to: Re: [gentoo-doc] Wiki, Take #whatever by wireless
1 wireless wrote:
2 > Josh Saddler wrote:
3 >> AllenJB wrote:
4 >>> Request for clarification:
5 >>> So you're proposing that if I write a good article on the wiki, the
6 >>> Gentoo devs should take that article, XMLify it and put it on the static
7 >>> site where I can't update it easily?
8 >
9 > Your docs on your wiki, should follow whatever semantic you like. Nobody
10 > is talking about hi-jacking your (wiki) docs. I'm talking about
11 > maybe one out of fifty docs that one typically finds on a wiki, could
12 > be motivation (and yes some ideas) on creating a similar doc that
13 > is officially bless and maintained, to a much higher standard and
14 > address things such that they can influence some of the existing
15 > official docs.
16
17 If there's already a high quality document on the wiki, why is there a
18 need to duplicate efforts? Surely it's the areas NOT already covered by
19 high quality documentation that should be concentrated on.
20
21 >
22 >> Actually, I'm not sure that guy had anything to say, really. But yeah,
23 >> you're right; basically, it's a bad idea. If you write the article, best
24 >> to keep it someplace where you know it'll easily receive TLC.
25 >
26 >
27 > Um, I think your both confused what I'm trying to say. I'll restate it,
28 > hopefully a little bit more clearly.
29 >
30 > Running a wiki, which usually has many folks actively involved, where
31 > the emphasis is on quantity of docs, not rigid uniformity, and where the
32 > particular selection of docs will usually be vastly larger than any
33 > official distro docs, you have completely different semantics, so they
34 > cannot be merged, without great pain, compromise and huge amounts
35 > of time.
36 >
37 >
38 > Let the wiki, (or any number of wikis) exist unto themselves. However,
39 > if a really good topic comes up, then those officially under much
40 > tighter constraints, such as GDP or infra, should consider maintaining
41 > a similar doc, that is held to much tighter (semantics) controls.
42
43 Again, you're suggesting duplication of efforts. What point would this
44 have? What problem would it fix?
45
46 > Let's face it. We all re-hash much of the same content on different
47 > linux distros, or even the same linux distro, so *I* do not see any big
48 > deal with this concept. Google for something and often you find multiple
49 > wikis that address a given subject with different docs, but with much
50 > that is common. Occasionally one will see a reference to that original
51 > doc that inspired the derivative. Often the wiki docs are old and not
52 > maintained, for a variety of reason.
53
54 While this was true of the old wiki, it is certainly not true of the
55 documents on the new Gentoo Wiki - they are being checked for accuracy
56 and errors by a team of volunteers as they are being entered. We will be
57 doing our best to keep it this way.
58
59 We're also already considering methods of indicating documents which we
60 believe to be particularly good or particularly bad.
61
62 > Just google for how to install a
63 > camera on a linux machine for a myriad of ideas. It sure would be nice
64 > to have an officially maintain basic video setup on gentoo, either using
65 > capture cards or a cheap webcam, as a baseline
66 > for folks to get something working. (using my previous example). It
67 > would not have to be encompassing but it should be maintained to GDP
68 > or such standards. Then let the wiki document, via dozens of different
69 > documents, many of the finer, fast moving aspects of cameras and video.
70 > I.E. *Complimentary documents* not competing documents....
71
72 Why can't, where they exist, the wiki document both? You're not going to
73 be able to stop people documenting certain things on the wiki (and as an
74 admin of the wiki, I don't believe you'd want to).
75
76 >
77 > Two docs that address the same subject, one on a wiki, the other part of
78 > the official gentoo docs is good for users.
79 How is it good for users? Now they have to judge which document to follow.
80
81 > The official docs will never
82 > be as numerous as other docs folks use to solve a problem or at
83 > least get some ideas how to install or fix something. However what is
84 > part of the official docs should be rigorously maintained, and held to a
85 > much higher standard, than the typical wiki, imho.
86
87 > There is a reason we have many motorcycles and many vehicles with 4
88 > wheels. However, how often do you see a three-wheeled vehicle? Sure they
89 > exist, but, they are not common and they are very easily wrecked.
90 > Remember the early ones for recreational vehicles in the 1980s? They
91 > have been baned here in the US, because they were prone to catastrophic
92 > failure. Ditto for merging a wiki and official distro docs.
93
94 I don't see what this analogy has to do with this discussion at all. It
95 seems to be totally unrelated to me.
96
97 >
98 > ymmv,
99 > James
100 >
101
102 In my opinion, the Gentoo Documentation Project is there to maintain
103 documentation on issues specifically related to Gentoo and issues which
104 you'd expect to find official documents on. Things like upgrading to
105 baselayout 2 or upgrading to a newer profile.
106
107 Meanwhile the wiki is there to basically document everything else. How
108 to install and configure software or hardware (perhaps in a specific way).
109
110 There will always be some crossover, but that's the main "areas of
111 responsibility" that I see each covering.
112
113 AllenJB