From: AllenJB <gentoo-lists@allenjb.me.uk>
To: gentoo-dev@lists.gentoo.org
Subject: Re: [gentoo-dev] [Gentoo Phoenix] an official Gentoo wiki
Date: Sun, 04 Apr 2010 11:35:22 +0100 [thread overview]
Message-ID: <4BB86B6A.4060500@allenjb.me.uk> (raw)
In-Reply-To: <20100404003152.4b2012da@angelstorm>
On 04/04/10 08:31, Joshua Saddler wrote:
> <lots of stuff about what mediawiki supposedly can't do that is just completely untrue>
GuideXML may be better for the Handbook use case, with its ability to
produce single page and multipage documents, but frankly I think that
for the rest of the documentation, most of which only covers 1 or 2
pages, the ease of learning and editing mediawiki formats is far
superior. (I wouldn't be surprised if there's a way to reproduce this
single-page and multipage ability using inclusion on mediawiki)
I keep hearing this line about GuideXML not being hard to learn, but if
that's so true, why does Gentoo have so few developers contributing to
the documentation? Why does the current system basically rely on a
single developer tidying up and completing the documentation?
I've tried getting my head around GuideXML a few times and I hate
dealing with it. I much prefer to use the Gentoo Wiki, where I can just
throw stuff up really quickly using a syntax I use in many other places
and is well documented.
This line about learning wiki syntax is so old, but here's my reply yet
again: GuideXML is a non-tranferrable skill. Nowhere else in the entire
world uses it. Even if you haven't edited a wiki anywhere else, chances
are you probably will one day, and even if it's not mediawiki it'll
probably use syntax that's similar to it in many ways.
Syntax highlighting can easily be done with any of a number of plugins.
I'm sure ebuild syntax could be added without a massive amount of pain.
There are multiple ways to construct tables (wiki style, HTML and
probably some others - almost certainly more available via plugins),
some easier than others. And you can do styling either inline or in the
site-wide stylesheets.
Mediawiki has built-in intradoc linking to every heading, and in all the
use cases I've seen this level is fine. Intradoc linking to individual
letters^Wparas is just frankly way overboard (Does the Gentoo
documentation even use it anywhere?).
Wiki's may not be a magic bullet that'll solve all of Gentoo's problems,
but the current system doesn't seem to be working well, so something
needs to change, and I believe that a system that allows more people to
contribute more easily, using a syntax that's already widely used so is
either already known or an easily transferable skill is not a bad place
to start.
AllenJB
next prev parent reply other threads:[~2010-04-04 10:35 UTC|newest]
Thread overview: 84+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-04-03 13:19 [gentoo-dev] [Gentoo Phoenix] an official Gentoo wiki Ben de Groot
2010-04-03 13:40 ` Dror Levin
2010-04-03 14:12 ` Tobias Scherbaum
2010-04-03 14:36 ` Ben de Groot
2010-04-03 23:41 ` Sebastian Pipping
2010-04-03 15:03 ` Nathan Zachary
2010-04-03 17:40 ` AllenJB
2010-04-03 18:56 ` George Prowse
2010-04-03 19:04 ` Alex Legler
2010-04-04 23:19 ` Ben de Groot
2010-04-10 4:10 ` William Hubbs
2010-04-10 11:55 ` Ben de Groot
2010-04-10 12:06 ` Dror Levin
2010-04-10 15:25 ` William Hubbs
2010-04-10 15:40 ` George Prowse
2010-04-10 17:18 ` William Hubbs
2010-04-10 18:11 ` [gentoo-dev] " Duncan
2010-04-10 18:26 ` René 'Necoro' Neumann
2010-04-11 9:52 ` Duncan
2010-04-11 3:05 ` [gentoo-dev] " Patrick Nagel
2010-04-10 18:04 ` Vincent Launchbury
2010-04-10 19:23 ` Dale
2010-04-11 4:35 ` William Hubbs
2010-04-14 2:03 ` George Prowse
2010-04-10 13:35 ` George Prowse
2010-04-11 1:08 ` Jorge Manuel B. S. Vicetto
2010-04-03 14:04 ` Guy Fontaine
2010-04-03 14:12 ` Ben de Groot
2010-04-03 15:25 ` Sylvain Alain
2010-04-03 14:30 ` Alex Legler
2010-04-03 14:46 ` Ben de Groot
2010-04-03 23:37 ` Sebastian Pipping
2010-04-04 1:20 ` Ben de Groot
2010-04-04 7:31 ` Joshua Saddler
2010-04-04 8:29 ` Arun Raghavan
2010-04-04 8:47 ` Sebastian Pipping
2010-04-04 12:26 ` Ben de Groot
2010-04-04 8:48 ` Antoni Grzymala
2010-04-04 8:54 ` Sebastian Pipping
2010-04-04 9:10 ` Alex Legler
2010-04-04 12:31 ` Ben de Groot
2010-04-04 16:54 ` Antoni Grzymala
2010-04-04 9:01 ` Alex Legler
2010-04-04 10:35 ` AllenJB [this message]
2010-04-04 13:43 ` Sylvain Alain
2010-04-04 14:15 ` Dror Levin
2010-04-04 14:33 ` AllenJB
2010-04-04 14:47 ` Dror Levin
2010-04-04 15:13 ` AllenJB
2010-04-04 15:36 ` dev-random
2010-04-04 15:39 ` Ben de Groot
2010-04-04 16:08 ` Ben de Groot
2010-04-04 22:45 ` Zeerak Mustafa Waseem
2010-04-04 22:21 ` AllenJB
2010-04-04 23:11 ` Ben de Groot
2010-04-05 1:36 ` Zeerak Mustafa Waseem
2010-04-04 16:00 ` Ben de Groot
2010-04-04 15:23 ` Ben de Groot
2010-04-04 19:33 ` Joshua Saddler
2010-04-04 19:46 ` George Prowse
2010-04-05 0:08 ` Ben de Groot
2010-04-05 1:13 ` Joshua Saddler
2010-04-05 2:43 ` Ben de Groot
2010-04-05 5:04 ` Arun Raghavan
2010-04-05 5:05 ` Arun Raghavan
2010-06-07 12:27 ` Ed W
2010-06-07 12:19 ` Ed W
2010-04-04 9:30 ` Alex Legler
2010-04-03 19:13 ` Alex Legler
2010-04-03 23:44 ` Sebastian Pipping
2010-04-05 0:02 ` Alistair Bush
2010-04-05 0:25 ` Ben de Groot
2010-04-05 4:46 ` [gentoo-dev] " Duncan
2010-04-05 0:37 ` [gentoo-dev] " Matti Bickel
2010-04-05 2:01 ` Jorge Manuel B. S. Vicetto
2010-04-05 3:02 ` Ben de Groot
2010-06-03 20:44 ` René 'Necoro' Neumann
2010-06-03 22:49 ` Ben de Groot
2010-06-04 3:53 ` Tobias Scherbaum
2010-06-04 4:52 ` Sebastian Pipping
2010-06-04 5:51 ` [gentoo-dev] " Torsten Veller
2010-06-04 8:12 ` Markos Chandras
-- strict thread matches above, loose matches on Subject: below --
2010-04-04 0:11 [gentoo-dev] " Sylvain Alain
2010-04-04 0:24 ` Sebastian Pipping
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=4BB86B6A.4060500@allenjb.me.uk \
--to=gentoo-lists@allenjb.me.uk \
--cc=gentoo-dev@lists.gentoo.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox