Topic: Wiki documentation

One thing that PunBB lacks is documentation. It has a FAQ that is distributed with every release, but that FAQ is aimed at administrators and not end users. I'm considering setting up some form of PunBB Wiki Documentation project.

How does that sound? Do you know any good PHP Wiki applications?

"Programming is like sex: one mistake and you have to support it for the rest of your life."

Re: Wiki documentation

I have heard some rumors about a lightweight but nonetheless quite stylish system, GPL'ed and very easy to install too. I think it was called ponWiki or punWiki or something like that :-) Might just be vaporware though...

Re: Wiki documentation

sounds good

and on B I answer C: google big_smile

Re: Wiki documentation

CodeDuck wrote:

Might just be vaporware though...

Yeah, anything starting with Pun most be a joke right? :)

"Programming is like sex: one mistake and you have to support it for the rest of your life."

5 (edited by sleddog 2004-04-27 20:05)

Re: Wiki documentation

I find Wakka Wiki to be quite nice -- http://www.wakkawiki.com/WakkaWiki

Lightweight, very easily set up and customized. See my own installation here: http://www.labradorstraits.net/wiki/

You can easily incorporate add-on things (PHP coded) like for example the download section on this page: http://www.labradorstraits.net/wiki/MozillaBuild

Re: Wiki documentation

Yes, I've had a go with WakkaWiki before, but the rate of development troubles me. It almost seems abandoned.

"Programming is like sex: one mistake and you have to support it for the rest of your life."

7 (edited by jacobswell 2004-05-06 00:03)

Re: Wiki documentation

How about MoniWiki?
http://moniwiki.sourceforge.net/wiki.php

Current version support DBA database style only, but We can change it.

It supports index, diff,history...etc.

You can see it here : http://cheekyworks.com/wiki/wiki.php/FrontPage also.

go and test it.

8 (edited by s0da 2004-05-06 02:25)

Re: Wiki documentation

this seems quite useful. i haven't installed it or anything. but it looks good and to the point; just a documentation placer.

PHP Doc System
Demo

Re: Wiki documentation

OMG. There are so many different wiki implementations, I have no idea which one to choose. MySQL is a requirement though.

s0da: Alex does lots of cool stuff, but I'm not sure his PHP Doc System is what we're after. We want to document how to use PunBB, not the source code/API.

"Programming is like sex: one mistake and you have to support it for the rest of your life."

Re: Wiki documentation

Maybe a FAQ, question/answer approach with categories might be appropriate...

A few examples culled from freshmeat.net (I haven't used any of these):

http://oodie.com/project/odfaq/
http://pineappletechnologies.com/products/lore/
http://www.phpmyfaq.de/

Re: Wiki documentation

I'm kinda in to the whole Wiki thing though. I love the fact that people can contribute themselves without having to involve me :D

"Programming is like sex: one mistake and you have to support it for the rest of your life."

Re: Wiki documentation

I believe some if not all of the FAQ applications have memberships so multiple contributors are supported. I also like Wikis, but it raises some interesting issues wrt documentation. For example, if everyone can contribute, who will ensure that the text is in fact accurate? About the only thing worse that no documentation is incorrect documentation smile

Re: Wiki documentation

Well, that problem can be solved by appointing one or more poeple that are responsible for the "integrity" of the wiki.

"Programming is like sex: one mistake and you have to support it for the rest of your life."

14

Re: Wiki documentation

The list of wiki engine: http://c2.com/cgi/wiki?WikiEngines

I think http://www.wakkawiki.com/WakkaWiki is the best for PunBB: simple & fast, just like punBB smile

Re: Wiki documentation

Just to throw in another thought- drupal.org
http://drupal.org/book/view/1

Allows for discussion-based items and some blogging for discussion of things to do. And collabrative "book building" capability for the docs....

Just a thought smile

Every Day Above Ground Is A Good One!!

Re: Wiki documentation

this one seems very slimlined ... (and active)
http://www.roboticboy.com/blastwiki/

Re: Wiki documentation

Frank H wrote:

this one seems very slimlined ... (and active)
http://www.roboticboy.com/blastwiki/

Would one be concerned about this from front page:

PLEASE NOTE: Because of the open nature of wiki I cannot be responsible for its content. It is also very vulnerable to hacking attacks. FOR THE LAME GUYS OUT THERE : HACKING BLAST IS NOT HARD, DOING IT IS NOT COOL AT ALL.

Every Day Above Ground Is A Good One!!

Re: Wiki documentation

well .. it's wiki, everyone can edit, so it's a risk you have with most of them ... (but you can lock pages if you want)

Re: Wiki documentation

People messing up a Wiki is one thing, but "hacking" is another. We don't want a Wiki that can be easily hacked.

"Programming is like sex: one mistake and you have to support it for the rest of your life."

Re: Wiki documentation

True, but hacking in that context I would think is just the 'messing up' part. But if it's truly hacking ... then it's not a good option.

21 (edited by sleddog 2004-05-19 11:39)

Re: Wiki documentation

Have a look at Trac (if you haven't already):

http://www.edgewall.com/products/trac/

I haven't used it so can't really comment, aside from saying it looks interesting. From the website:

What is Trac?

    * An integrated system for managing software projects
    * An enhanced wiki
    * A flexible web-based issue tracker
    * An interface to the Subversion revision control system

It's free and open source.

Re: Wiki documentation

It sure looks promising! It also integrates with subversion (which I think is very cool).

"Programming is like sex: one mistake and you have to support it for the rest of your life."

23

Re: Wiki documentation

That looks very nice... smile

24

Re: Wiki documentation

Is there any update? What I'm looking for is a wiki as reduced to the max as PunBB. wink

Re: Wiki documentation

i did a dokuwiki integration http://punres.org/desc.php?pid=68