On Aug 13, 2012, at 2:37 PM, Ludovic Dubost wrote: > 2012/8/13 Vincent Massol <[email protected]>: >> Hi Ludovic, >> >> +1 to have it linked from >> http://platform.xwiki.org/xwiki/bin/view/DevGuide/API (we still need that >> page to offer various versions of the API doc). > > Just to make sure, we can now move the application to > platform.xwikisas.com and put the javadocs on the > platform.xwikisas.com web site exposed by Apache ?
You mean platform.xwiki.org right? If so, yes it's fine from my POV. You can create a space on platform.xwiki.org if there are several pages. We already have a place for publishing javadocs (more generally maven sites): /home/maven/public_html/site (on maven.xwiki.org, under the "maven" user) I suggest to have /home/maven/public_html/site/docs/<version> for now >> How do you discover the bindings, services, plugins, velocity tools, etc? Is >> this static or autodiscovered? > > This had been done by Andrei using a script to discover all > implementations of specific classes. > He will be in charge of detecting new ones at each version as well as > look at older version to mark when they first appeated. > >> >> If it's static we'll need to define how to maintain the doc. We'll need a >> volunteer for that or find a way to maintain it through a process. > > Andrei can do that. ok great. Andrei will need to work with the community to improve all the scripts used and put under version control in the xwiki project. The very minimum is to make the scripts available somewhere (we need to conclude our discussion about the Git repo for tools) + add documentation on dev.xwiki.org to explain how to use them to generate the end result. Thanks -Vincent > Ludovic > >> >> Thanks >> -Vincent >> >> On Aug 9, 2012, at 12:11 PM, Ludovic Dubost wrote: >> >>> 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 _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
