[jbosscache-dev] Lets ditch docbook (long-term)
Bela Ban
bela at jboss.com
Tue Jun 3 09:26:32 EDT 2008
+1 in general, *IF*
1. There is a converter from docbook to the new wiki
2. Ease of use:
1. how easily can I import figures (e.g. PNG), is there some
wysiwyg editor ?
2. Since most wikis have a stupid and very limited markup
language: how powerful is the wiki's markup language
compared to docbook ?
The advantages are
* Potentially more collaboration from the community
* Quick to change docs
* *One* source for wiki and docu
Manik Surtani wrote:
> I'm cc'ing Mark Newton on this thread.
>
> I'm about to start work on 3.0.0, and 3.0.0 would be a nice "boundary"
> around which we can switch documentation systems as well.
>
> So in summary:
>
> * Maven is a Piece Of Sh*t.
> * Docbook isn't much better.
> * UserGuide, FAQ and Tutorials are better maintained on a wiki.
> * One for each *minor* version. E.g.,
> http://docs.jbosscache.org/wiki/3.0/UserGuide and
> http://docs.jbosscache.org/wiki/3.2/UserGuide, etc.
> * Wikis should be read-only to the public.
> * Logged in members on jboss.org should be able to add comments on any
> page, like MySQL and PHP docs.
> * Admins (committers) should be able to edit the docs themselves.
> * A "generate PDF" feature should be available, so people can get a
> hold of printable copies of the user guide, tutorial, etc.
> * Stop shipping docs with JBC distros and point people to the online
> resource.
>
> What do people think?
>
> Mark, does ClearSpace offer what we want from such a "documentation"
> wiki?
--
Bela Ban
Lead JGroups / Clustering Team
JBoss - a division of Red Hat
More information about the jbosscache-dev
mailing list