Hi Developers,
With the help of Andrei (from the XWiki SAS support team), we have
worked on a prototype to provide a reference documentation for XWiki
scripting development.
We have found that new XWiki developers have difficulties getting
around everything that's available in XWiki and struggle a bit to find
the appropriate documentation.
Providing a reference documentation would go a long way to help the
developers getting up to speed faster. This is the objective of this
prototype.
You'll find the design page here:
http://dev.xwiki.org/xwiki/bin/view/Design/DeveloperReferenceDocumentation
A first prototype is available here:
http://incubator.myxwiki.org/xwiki/bin/view/ScriptingReferenceDocumentation…
At this point it only provides documentation for the latest version
(4.1.x), but it's already quite good as we have nothing really good
currently.
The first step would be to find a home on
xwiki.org for this documentation.
It could be:
http://dev.xwiki.org/xwiki/bin/view/ScriptingReferenceDocumentation/
We also need a space to store all the builds of the full javadoc of
the XWiki platform for each version (I don't think using ZipExplorer
is a good idea given the size of the zip of the javadoc).
I suggest making them available through Apache at:
http://dev.xwiki.org/docs/${version}
If that's ok I can proceed to publish the prototype on
dev.xwiki.org
and continue on the plan listed on the design wiki.
Any comments and ideas are of course welcome.
Ludovic
--
Ludovic Dubost
Founder and CEO
Blog:
http://blog.ludovic.org/
XWiki:
http://www.xwiki.com
Skype: ldubost GTalk: ldubost