Vote to include this scripting documentation on http://platform.xwiki.org/
including the expanded javadocs on the file system of this server (until a wait to build using maven is found). Here is my +1 Ludovic ---------- Forwarded message ---------- From: Ludovic Dubost <[email protected]> Date: 2012/8/8 Subject: Re: [xwiki-devs] Developer Scripting Reference Documentation Prototype To: XWiki Developers <[email protected]> Cc : XWiki Developers <[email protected]> Envoyé de mon iPhone Le 8 août 2012 à 15:21, Thomas Mortagne <[email protected]> a écrit : > On Wed, Aug 8, 2012 at 1:37 PM, Ludovic Dubost <[email protected]> wrote: >> 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/Navigation?xpage=embed > > Need to UI improvements but it's very useful already. > >> >> 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/ > > Actually dev.xwiki.org wiki is about development of XWiki itself and > here it looks more like a user (even if dev user) documentation so > platform.xwiki.org would probably be a better place. Right > >> >> 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} > > You mean expended, not as zip packages, right ? > Yes expanded > I don't know how you generate it but if you are able to generate it Check the design page. The generation script is there > during a maven build we could simply access it trough nexus javadoc > package support like in > http://nexus.xwiki.org/nexus/service/local/repositories/releases/archive/org/xwiki/platform/xwiki-platform-oldcore/4.1.3/xwiki-platform-oldcore-4.1.3-javadoc.jar/!/index.html. > It would also make easier to have one generated automatically for each > release if it's part of the build. This is where maven specialists are needed. It requires the whole tree of all sources and needs a few specific jar to not fail. I've no idea how to do that using maven as usually it's per module If a maven specialist can look it would've great. Ludovic > >> >> 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 >> _______________________________________________ >> devs mailing list >> [email protected] >> http://lists.xwiki.org/mailman/listinfo/devs > > > > -- > Thomas Mortagne > _______________________________________________ > devs mailing list > [email protected] > http://lists.xwiki.org/mailman/listinfo/devs -- Ludovic Dubost Founder and CEO Blog: http://blog.ludovic.org/ XWiki: http://www.xwiki.com Skype: ldubost GTalk: ldubost _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
