1 |
Xavier Neys wrote: |
2 |
> AllenJB wrote: |
3 |
> |
4 |
>> The basic idea is to replace the current documentation with something |
5 |
>> that's much easier to edit. |
6 |
>> |
7 |
> |
8 |
>> On top of that the Handbooks in particular are (at a glance) a maze of |
9 |
>> multiple files pieced together into the finished product (I haven't got |
10 |
>> round to checking whether this maze is mapped out anywhere yet - I had |
11 |
>> multiple things on my todo list at the time and decided to just move on |
12 |
>> to the next item). |
13 |
> |
14 |
> Easy, refresh your anoncvs, create a debug.xml file in your document |
15 |
> root that contains |
16 |
> <debug on="1"/> |
17 |
> |
18 |
> and voilà, you see the file names. |
19 |
|
20 |
Thanks for the tip. |
21 |
|
22 |
> |
23 |
>> On the other hand, I (and I suspect a large number of other people in |
24 |
>> general) use wiki's quite a lot, am familiar with the syntax and find |
25 |
>> them a breeze to edit. In my opinion, it is likely the the official |
26 |
>> documentation would receive more, faster contributions if they were on a |
27 |
>> wiki instead of built using GuideXML. |
28 |
> |
29 |
> In other words, you want the current docs team to learn a new syntax and |
30 |
> a new tool, and infra to install a new system because you can't learn a |
31 |
> dozen simple tags, you know like <p> for a paragraph... |
32 |
> |
33 |
> |
34 |
> Wkr, |
35 |
|
36 |
The existing docs team may know GuideXML well, but it seems to me that |
37 |
the existing docs team isn't sufficient and needs some new blood that it |
38 |
currently isn't getting. 2008.0 has been deprecated for months, |
39 |
autobuilds have been out for months, eselect profile is now available |
40 |
for profile selection and yet the handbooks haven't been updated at all |
41 |
(they even still mention the GRP, which iirc was never released for 2008.0!) |
42 |
|
43 |
How many of the existing docs team have never worked with mediawiki (or |
44 |
another wiki - I'm using mediawiki as an example because I suspect it's |
45 |
the most likely choice)? It might be an idea to do a quick survey before |
46 |
claiming the entire team would have to learn a new syntax - you might |
47 |
find that everyone on the docs team is already familiar with mediawiki. |
48 |
Even if they're not, mediawiki syntax is extremely well documented and |
49 |
easy to learn, in my experience. |
50 |
|
51 |
At the end up the day, this is a suggestion. I've made the suggestion |
52 |
because I think that the way Gentoo documentation currently works (ie. |
53 |
because it's written in GuideXML) is cumbersome and makes it difficult |
54 |
to easily pick up. I believe this has led to a lack of volunteers with |
55 |
the available time and inclination to learn GuideXML just for Gentoo |
56 |
documentation work, which has led to the current situation with sorely |
57 |
needed handbook updates not getting done in a timely manner. |
58 |
|
59 |
Following the documented instructions, you have to check out a large cvs |
60 |
tree, which takes some time and disk space, set up gorg (which in my |
61 |
opinion isn't very well documented) and possibly a web server (I think |
62 |
gorg may be able to run standalone, but I don't know how well it works |
63 |
and I could be wrong). Then you have to learn GuideXML. Then you have to |
64 |
learn how the handbook files are structured. Only then might a newbie to |
65 |
Gentoo documentation editing be able to actually start editing some docs. |
66 |
|
67 |
Having a mediawiki based setup would, in my opinion, allow newbies to |
68 |
get involved much more quickly. A local install of mediawiki and apache |
69 |
takes literally minutes. A "fast" install would be something like: |
70 |
1) emerge apache mediawiki; |
71 |
2) Create database (& db user) (I think instructions for this are in the |
72 |
post-install for mediawiki); |
73 |
3) Configure mediawiki using the included wizard). You can easily export |
74 |
content from one wiki to import to another. |
75 |
|
76 |
As stated before, I believe many are already familiar with mediawiki |
77 |
syntax due to its already extensive use in open source documentation and |
78 |
it's extremely well documented and easy to learn, with lots of support |
79 |
already available. |
80 |
|
81 |
I realize that there's work for infra involved in installing and |
82 |
maintaining a wiki. I realized that there's possibly work for some of |
83 |
the docs team in learning a new system and in initially porting |
84 |
documentation over (but some of this porting work may be offset by |
85 |
people like me who already know mediawiki well who would be willing to |
86 |
lend a hand in this task). However, I believe that in the long term, the |
87 |
benefits will easily outweigh these issues. |
88 |
|
89 |
(Sorry if that's a bit long-winded. It started as a 2 paragraph reply |
90 |
and kept growing =o ) |
91 |
|
92 |
AllenJB |