[openbeos] Re: HaikuPedia / One hour challenge
- From: "John '[Beta]' Drinkwater" <john@xxxxxxxxxxxxx>
- To: openbeos@xxxxxxxxxxxxx
- Date: Wed, 20 Apr 2005 12:57:54 +0100
> SOLUTION
> We need a HaikuPedia, with 2 sections. The first section is the
> 'Quick start', which will explain the most common questions a new user
> may have, and the second section is your normal 'user guide'. The
> HaikuPedia will probably be in HTML format, and it would be great if
> we can integrate it with BeHappy (http://www.bebits.com/app/430) or
> similar for search capabilities. So what are the most common
> questions newbies will have?
CCed to glasselevator; wondering if Haiku needs/requires a help system - BeOS
seems to do well without one.
OK, so if this idea moves to a Wiki system, how does that change the following
> PROPOSAL
> a) Create a new SVN directory for the HaikuPedia.
> b) Mirror the contents of these files on the Haiku website (online
> documentation).
> c) Provide an email link on the Haiku main page for documentation
> submissions (from volunteers without SVN access), ie.
> submit_docs@xxxxxxxxxxxxx
> d) Have the Creative Design team modify the style of each submitted
> page so that it adheres to a common standard (style, colour,
> background pattern, fonts, image borders etc).
> e) Invite volunteers to submit pages. We need to fill the both
> sections of the HaikuPedia.
> f) Distribute the HaikuPedia with Haiku
> ...
> z) The HaikuPedia MUST be fun to read.
WIKI
a) Setup wiki.haiku-os.org or haiku-os.org/wiki/
b) Allow anyone to submit/edit pages, require basic registration. This will
encourage people to populate the wiki.
c) Cover the Wiki under a CC/MIT license
d) Creative design team produce *one* style, a few templates, and wiki & css
should avoid additional workload so that the design team can get on with other
things.
e) Produce weekly(?) dumps of the wiki into flatfile (html) format
f) Distribute these along with Haiku
g) supporting translations comes for free, as long as you have the contributors.
h) The HaikuPedia SHOULD be fun to read.
Personally, I think the idea is great.. but refering the Neils' QA post, how
will pour speeling and grammer affect this idea; Unless it's kept maintained,
and well, it can reflect badly on the Haiku project.
We'd have to setup some kind of review system to finalize/recommend pages,
though I dont know how informal this could be - I'd be OK to proof read pages,
though I do like split infinitives.
John
Ian K wrote:
On 4/20/05, Ivan Vodopiviz <merkoth@xxxxxxxxx> wrote:
Hi,
looks like an interesting idea. anyway, I'm sure that a Style
Guideline will be needed, to save the Creative Design team of going
insane in two weeks ;-)
I think that this can be done more easyly by using a WikiWikiWeb
system. yeah, I know, they're slow and consume quite a bit of
bandwidth, but they're the best option when doing documentation.
I have to say, the MediaWiki system used by Wikipedia et al. is the
most user friendly Wiki I've used. A lot of Wikis look very bleak,
blocky and unhelpful, including the WikiWikiWeb, that I've seen.
Admittedly, it may be a little more bandwidth intensive than
WikiWikiWeb, and uses PHP rather than Perl, but it has a lot of
features that aid in indexing and searching that I believe make it
more suitable for a documentation project.
Making the documentation a live Wiki does unfortunately mean that you
need to have a local webserver + scripting of choice running by
default if you want to distribute it with the CD.
See [e]
'Course, if I've missed the point, feel free to disregard. :)
-Ian
*offering bananas to the Perl monkeys*
Other related posts:
