| 1 |
-----BEGIN PGP SIGNED MESSAGE----- |
| 2 |
Hash: SHA1 |
| 3 |
|
| 4 |
Lance Albertson wrote: |
| 5 |
> Luis Medinas wrote: |
| 6 |
> |
| 7 |
>>On Sun, 2006-01-08 at 12:54 -0600, Lance Albertson wrote: |
| 8 |
<snip snip> |
| 9 |
> |
| 10 |
> |
| 11 |
> I had thought about creating some kind of a site like this, but not |
| 12 |
> necessarily in a wiki form. I don't like the idea of letting users add |
| 13 |
> random docs. There's too much room for error and how do you deal with |
| 14 |
> accountability? There has to be a developer who either will take the |
| 15 |
> time to maintain it or accept responsibility for any errors it may have. |
| 16 |
> I like the idea of having an area for herds to keep track of their |
| 17 |
> internal thing, but I fear it will just end up replacing what the GDP |
| 18 |
> (and our www site) does. Its too easy for them to just start adding docs |
| 19 |
> there instead of on www because its 'too hard' to deal with guidexml. |
| 20 |
> |
| 21 |
> If the issue here is guidexml, lets figure out the problem. We need to |
| 22 |
> define what exactly is the problem before we decide on an |
| 23 |
> implementation. Is the problem that there's no central place for herds |
| 24 |
> to put updates/goals/etc? Is the problem that there's no easy way for |
| 25 |
> users to submit new docs for people to use? Is the problem that guidexml |
| 26 |
> hampers development time with regard to creating docs and you wish to |
| 27 |
> have a better/easier way to create such docs? |
| 28 |
> |
| 29 |
> Simply saying 'we need a public wiki' is great an all, but I'd rather |
| 30 |
> ask 'What problem(s) does the wiki solve' before we even get farther. |
| 31 |
> There might be better ways to solving the problem other than putting up |
| 32 |
> a wiki. |
| 33 |
> |
| 34 |
|
| 35 |
I think the big problem with certain pieces of documentation is the fact |
| 36 |
that: |
| 37 |
A) They change too often for any sort of static webpage. If I'm writing |
| 38 |
portage docs GuideXML is probably not how I want to go, the docs are |
| 39 |
essentially fluid for most of the development time, they change often, |
| 40 |
entire sections are ripped out and moved as I go. In that type of case |
| 41 |
any sort of static webpage is utterly horrible. Rather go a wiki route |
| 42 |
( or something similar ) to allow easy access & modification. |
| 43 |
|
| 44 |
One could say, build the docs offline and then submit them later for GDP |
| 45 |
to stick into GuideXML, but then only I can contribute to them ( myself |
| 46 |
not being a developer ). I guess I could host my own Anon-svn for the |
| 47 |
docs while they are being written, but not particularly my cup of tea. |
| 48 |
|
| 49 |
B) Non-developers want to contribute. The devwiki currently doesn't |
| 50 |
allow this, so I ended up asking Patrick at ge.org for an account to |
| 51 |
start a wiki there, hoping eventually to move it somewhere else ( or if |
| 52 |
events stay as they are, it can stay there ) Not many people want to |
| 53 |
make diffs on guideXML ( I know I hate editing it ), and to fix a small |
| 54 |
error or add a tidbit, no one wants to file a bug about it. |
| 55 |
|
| 56 |
Those are the two biggest, docs change fast and non-devs want to |
| 57 |
contribute to documentation in an easier way. |
| 58 |
|
| 59 |
Problems with any sort of wiki solution thats Gentoo-wide comes down to |
| 60 |
people editing projects they know nothing about, and managing |
| 61 |
permissions should they be implemented. I could probably do well |
| 62 |
editing the Portage section, but perhaps no so much in any Hardened area |
| 63 |
of the wiki. Problem is maintaining that number of users/permissions is |
| 64 |
a nightmare. |
| 65 |
|
| 66 |
But those are the two biggest problems in my estimation. No one wishes |
| 67 |
to impede the GDP here, Most of the docs I want to write are internal |
| 68 |
portage API docs/FAQ/Howto's, and I doubt you will see users pounding on |
| 69 |
the door to read them :) |
| 70 |
|
| 71 |
Alec Warner (antarus) |
| 72 |
-----BEGIN PGP SIGNATURE----- |
| 73 |
Version: GnuPG v1.4.2 (GNU/Linux) |
| 74 |
Comment: Using GnuPG with Thunderbird - http://enigmail.mozdev.org |
| 75 |
|
| 76 |
iQIVAwUBQ8GBPWzglR5RwbyYAQINoA//U6CGfhwWcIKWOdr2UmbtarIbPoiFZ7Hc |
| 77 |
2TcITLjnEqNFq28Va7cjKsS3Ef4BdoWY4UbhP+YCWPhqCPiFEOG4hEjsxeBQC4/v |
| 78 |
7mvaC9EB2kVJRRZtl5WCtWeOzrsxc/ebtgOL1F8TL040AevD5BTYQKngS/9sEdl6 |
| 79 |
HyfY/i6Jbg5m8oFRCzA2vvzZAVHDPV92qxzKpfdfcAPC6FMHtdzimlASmcjjhAy2 |
| 80 |
FcUkYazzyy4888eO8tYZqpPX7ps8wUYVKfeLe55+EHpCC2jBp82NE++V2g9B0KcY |
| 81 |
9T4yfELm1UXs1C4GDaukpqjrhj+vUSrf1/fK9k1ebmEaW29cEGATjYqCxKEXqQ8R |
| 82 |
iCTgvpWDkc9yFRBLjscVW5ZS+jjfST/YlyCuLFNbFKoze1fyj6xqVVwMbnONNklO |
| 83 |
X3979tn8bz377ZRNdbURkllc3Rgs0U6hHhowM917s2KULis4XnNhQ01DIomTH3cO |
| 84 |
a0BVZo0tCYcNxPLqqlMD2xqTpgRrN7NPOOSTJIWQyWrzctnF2RaeznJSd96zzVPB |
| 85 |
XDY/OsmRLulJIrAQcGQHpkYnhlk0Oy1kglWqXlvF8+Zf8O65qoFeSYvy2Ettuh06 |
| 86 |
jziyI4rDzfdDSgBmDX9jcShLoKIfoIxIGH6HvuphSXTIVqgDEr/63tEcYbXnomMv |
| 87 |
qNdS/bUOXAg= |
| 88 |
=rMLi |
| 89 |
-----END PGP SIGNATURE----- |
| 90 |
-- |
| 91 |
gentoo-dev@g.o mailing list |
Archives