| 1 |
On 3 April 2010 11:46, Patrick Lauer <patrick@g.o> wrote: |
| 2 |
> On 04/03/10 11:16, Tobias Scherbaum wrote: |
| 3 |
>> People are constantly asking for a documentation wiki, but ... |
| 4 |
> yeah, as long as no one just creates a wiki there won't be one. People |
| 5 |
> are waiting on other people, who are waiting for Godot. Just do it. |
| 6 |
> |
| 7 |
> I remember the long and whiny road to get a blog aggregator - what |
| 8 |
> killed the waiting deadlock was simply karltk setting up one (unofficial |
| 9 |
> etc.etc.) and suddenly people saw that it was good. |
| 10 |
|
| 11 |
|
| 12 |
Okay, so it seems a lot of people do want a wiki. So let's see what |
| 13 |
we can do to make that happen. |
| 14 |
|
| 15 |
1 - requirements |
| 16 |
================ |
| 17 |
|
| 18 |
In order to choose the best possible wiki implementation, we need to |
| 19 |
know our requirements. So what features do you think are essential or |
| 20 |
good to have? What syntax would we prefer to use? |
| 21 |
|
| 22 |
I myself am a big fan of reStructuredText, which is quite simple, |
| 23 |
easy to pick up, highly readable, and has a good featureset. Plus, it |
| 24 |
is also reusable in other contexts (it is for example widely used in |
| 25 |
documentation of Python libraries). MediaWiki, MoinMoin and Trac have |
| 26 |
support for rst. |
| 27 |
|
| 28 |
Some others: |
| 29 |
|
| 30 |
- active upstream (bug fixes, security updates) |
| 31 |
- free open source software |
| 32 |
- ACLs |
| 33 |
- spam prevention measures |
| 34 |
- attachments (to upload screenshots for example) |
| 35 |
- feeds |
| 36 |
|
| 37 |
Other distros and open source projects surely have had the same |
| 38 |
considerations. Can we find out and learn from them? |
| 39 |
|
| 40 |
|
| 41 |
2 - maintainers |
| 42 |
=============== |
| 43 |
|
| 44 |
Who is volunteering for maintaining the wiki? We need editors and |
| 45 |
moderators, people who look out for quality control and take care of |
| 46 |
spam removal. So let's get together a team. I'm sure if we ask on the |
| 47 |
forums we'll get some users interested as well. |
| 48 |
|
| 49 |
|
| 50 |
3 - edit access |
| 51 |
=============== |
| 52 |
|
| 53 |
Do we keep to the original "free for all" model, with all the spam |
| 54 |
that includes, or do we go with registered users only? I think the |
| 55 |
latter is the smarter option. I also think we will want to mark |
| 56 |
certain pages "official" and lock down editing rights. |
| 57 |
|
| 58 |
|
| 59 |
Is there anything else we should consider before getting started? |
| 60 |
|
| 61 |
Cheers, |
| 62 |
-- |
| 63 |
Ben de Groot |
| 64 |
Gentoo Linux Qt project lead developer |
Archives