On 16 Jun 06, at 4:18 AM 16 Jun 06, Trygve Laugstøl wrote:

Trygve Laugstøl wrote:
Edwin Punzalan wrote:

Definitely deserves +1

However, I'm still torn between using apt and a wiki site but whichever wins I think the obvious casualty will be the site-plugin.

If we continue on using the pages generated by the site plugin, and based from John Casey's "Core Documentation" point #2, it will be a major revision to the site plugin to pull that off. But after that, things will be easier and the only problem I see will be the lack of contributions from outside the maven devs team bec, really, sending a patch for the first time is tedious. Plus the fact that after sending the patch, one will wait for it to be patched and deployed.

Now if we work on a wiki site, then a lot of the information (javadoc, changelog, etc) already generated by the site plugin will be under-utilized (if not unused) and they will have to be reproduced in the wiki. Although, this may probably be another plugin's work but its a wiki, so there will probably be user edits on the same page and those edits should then be propagated back to the plugin's docs (again, probably another plugin's work).

Maybe there's a way to use both the wiki and the pages generated by the site plugin altogether for this? So we can benefit from the pros of both.
I know there are code laying around to suck the content out of Confluence and transform that into a Doxia Source. Then with some shell magic we could import the documentation in Confluence and rebuild the site on a daily basis.

Ma, look what I found [1]!

[1]: https://svn.apache.org/repos/asf/maven/doxia/trunk/doxia- modules/doxia-module-confluence/src/main/java/org/apache/maven/ doxia/module/confluence/ConfluenceParser.java


This works reasonably well because I have used it to take a first shot at creating FAQ pages with it.

The intention was to take documentation in any form so we'll figure out the confluence parsing if people want to start making documentation.

There are some macros and things that don't quite work 100% yet but with an hour of work I'm sure it could cover most things.

Jason.

--
Trygve

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]



Jason van Zyl
[EMAIL PROTECTED]




---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to