Hi Victor,

Sounds good. My main comment would be to review the current API as it may not 
be perfect and it’s the time to make it better and better aligned with best 
practices of the xwiki dev in term of API.

Note: I haven’t reviewed it but I’m just saying that it should be reviewed IMO.

Generally speaking I don’t like the step you called “clone of the existing 
code”. IMO the code should be reviewed and improved. Backward compat will be 
broken anyway with the package name change.

Thanks
-Vincent


On 3 Dec 2014 at 16:11:59, Victor Rachieru 
([email protected](mailto:[email protected])) wrote:

> Hei devs,
>  
> I intend to integrate the ratings application which is now on xwiki-contrib
> into the xwiki-platform.
>  
> This in mainly due to 3 points:
> -----
> 1/ give the ability to use ratings in a wiki
> 2/ using it to provide ratings for the Extension Repository Application
> (XWIKI-7780)
> 3/ display ratings within Extension Manager (XWIKI-11509)
>  
> The first point can be accomplished by using the ratings app as is but the
> other two imply that the ratings app should be a module that is maintained
> by XWiki. It makes sense that if the Extension Repository App and Extension
> Manager which are maintained by XWiki depend on the Ratings App, that this
> itself is maintained by XWiki as well.
>  
> The steps needed for this is as follows:
> -----
> 1/ create a new module in the xwiki-platform core for the ratings
> - xwiki-platform-core
> -- xwiki-platform-ratings
> --- xwiki-platform-ratings-api
> --- xwiki-platform-ratings-ui
> 2/ change the artifact id from "application-ratings" to
> "xwiki-platform-ratings"
> 3/ change the package from "org.xwiki.contrib.ratings" to
> "org.xwiki.platform.ratings"
>  
> Implications
> -----
> 1/ clone of the existing code is now in xwiki-platform under a different
> artifact id (having duplicate code, this takes us to #2)
> 2/ the code from xwiki-contrib would probably have to be deemed as "retired"
> 3/ the applications with a dependency to the xwiki-contrib ratings would
> have to be upgraded to depend on the module from xwiki-platform
> 4/ the script service would remain unchanged (changing the artifact id and
> package name does not affect the service)
> 5/ if by any chance someone has code that uses the classes from the ratings
> app on contrib, by upgrading, that code will cease to function
>  
> Please state you position on this matter.
>  
> Links
> -----
> http://extensions.xwiki.org/xwiki/bin/view/Extension/Ratings+API
> http://extensions.xwiki.org/xwiki/bin/view/Extension/Ratings+Application
> https://github.com/xwiki-contrib/application-ratings
>  
> Thank you,
> Victor
> _______________________________________________
> devs mailing list
> [email protected]
> http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________
devs mailing list
[email protected]
http://lists.xwiki.org/mailman/listinfo/devs

Reply via email to