On Thu, Apr 5, 2012 at 6:19 PM, Vincent Massol <vincent(a)massol.net> wrote:
Hi devs,
Now that we're starting to use the Extension Manager (EM) we need to be careful about
the Description and Names we use in our pom.xml since they're used by the EM to
display information to the user. They're also used by the XR application to import
extensions located in maven repository into
extensions.xwiki.org (EXO).
Right now our names are of the type shown here:
https://gist.github.com/2311321
For example:
[INFO] XWiki Commons - Extension - Parent POM ............ SUCCESS [0.004s]
[INFO] XWiki Commons - Extension - API ................... SUCCESS [2.066s]
[INFO] XWiki Commons - Extension - Handler - Parent POM .. SUCCESS [0.017s]
[INFO] XWiki Commons - Extension - Handler - JAR ......... SUCCESS [0.133s]
[INFO] XWiki Commons - Extension - Repository - Parent POM SUCCESS [0.004s]
[INFO] XWiki Commons - Extension - Repository - Aether ... SUCCESS [0.132s]
[INFO] XWiki Commons - Extension - Repository - XWiki .... SUCCESS [0.006s]
[INFO] XWiki Commons - Extension - Repository - XWiki model SUCCESS [0.188s]
[INFO] XWiki Commons - Extension - Repository - XWiki api SUCCESS [0.010s]
[INFO] XWiki Commons - Extension - Repository - XWiki handler SUCCESS [0.024s]
These names are not nice names for users. Actually they're more IDs than names. And
having the users see those in our livetable on EXO isn't nice for example. Nor is it
nice if they see them in the EM UI.
I thus propose that we change the way we use names in our pom.xml to use English-readable
names, without any "XWiki" prefix.
For example, for the example show above we could have:
Extensions
Extension API
Extension Handlers
JAR Extension Handler
Extension Repositories
Aether Extension Repository
XWiki Extension Repository
XWiki Extension Repository Model
XWiki Extension Repository API
XWiki Extension Repository Handler
The alternative is to introduce a custom property in our pom.xm that would be used by the
EM and XR but that's not a good solution because it means even more maintenance work.
While not using technical id as names in our pom.xml is not as nice when displayed in the
Maven Reactor I feel it's still the best solution we have.
Here's my +1
+1, using names as... names sounds the best choice to me.
Thanks
-Vincent
_______________________________________________
devs mailing list
devs(a)xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs
--
Thomas Mortagne