[xwiki-users] How to make an extension which is installable by the extension manager?
Hi, I'm looking to contribute an extension which is installable with the EM and I can't find any documentation on it, if there is no documentation I am willing to write it if someone will walk me through the process. How do I go about getting published and how are dependencies declared? Thanks, Caleb
Hi Caleb, On Jan 4, 2013, at 8:41 PM, Caleb James DeLisle <[email protected]> wrote:
Hi,
I'm looking to contribute an extension which is installable with the EM and I can't find any documentation on it, if there is no documentation I am willing to write it if someone will walk me through the process.
How do I go about getting published and how are dependencies declared?
3 choices: 1) Your extension is published in a maven repo (e.g. the XWiki public maven repo at http//nexus.xwiki.org). This makes it installable directly by any XE instance. However Maven repos are not searchable so users won't be able to search for your extension and will need to enter the extension id/version in the Advanced Search. 2) Same as 1) but you wish to have your extension searchable. For this, it should be available on extensions.xwiki.org. To do that all you need is to "Import" your extension from the maven repo. This is the "import" action on extensions.xwiki.org 3) Your extension is NOT in a maven repo. You need to contribute it on extensions.xwiki.org and then follow the documentation to add dependencies (basically one object per dep). Feel free to document this. I think we could have a question mark icon on extensions.xwiki.org just after "Contribute extension" and when you click on it, it would go to a page listing what I've explained above, wdyt? Thanks -Vincent
Thanks for the help Vincent. I have the basics of a "My First Extension" tutorial by example. https://github.com/cjdelisle/my-first-xwiki-extension (It's very important to me that developing installable extensions be simple and intuitive) I'm trying to allow the user to deploy their extension to a local directory within their git repository and then they could push that to github or equivalent and import without having to ask that their key be included in maven.xwiki.org and deploying where they could break something. It seems to work: https://raw.github.com/cjdelisle/my-first-xwiki-extension/master/repo/org/xw... Where I'm hitting a wall is on the import phase, I need to be able to import from an arbitrary m2 repo in order for this technique to work. Is this possible with the EM as it is now? Thanks, Caleb On 01/05/2013 09:34 AM, Vincent Massol wrote:
Hi Caleb,
On Jan 4, 2013, at 8:41 PM, Caleb James DeLisle <[email protected]> wrote:
Hi,
I'm looking to contribute an extension which is installable with the EM and I can't find any documentation on it, if there is no documentation I am willing to write it if someone will walk me through the process.
How do I go about getting published and how are dependencies declared?
3 choices:
1) Your extension is published in a maven repo (e.g. the XWiki public maven repo at http//nexus.xwiki.org). This makes it installable directly by any XE instance. However Maven repos are not searchable so users won't be able to search for your extension and will need to enter the extension id/version in the Advanced Search. 2) Same as 1) but you wish to have your extension searchable. For this, it should be available on extensions.xwiki.org. To do that all you need is to "Import" your extension from the maven repo. This is the "import" action on extensions.xwiki.org 3) Your extension is NOT in a maven repo. You need to contribute it on extensions.xwiki.org and then follow the documentation to add dependencies (basically one object per dep).
Feel free to document this. I think we could have a question mark icon on extensions.xwiki.org just after "Contribute extension" and when you click on it, it would go to a page listing what I've explained above, wdyt?
Thanks -Vincent
_______________________________________________ users mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/users
On Tue, Jan 8, 2013 at 11:50 PM, Caleb James DeLisle <[email protected]> wrote:
Thanks for the help Vincent. I have the basics of a "My First Extension" tutorial by example. https://github.com/cjdelisle/my-first-xwiki-extension (It's very important to me that developing installable extensions be simple and intuitive)
I'm trying to allow the user to deploy their extension to a local directory within their git repository and then they could push that to github or equivalent and import without having to ask that their key be included in maven.xwiki.org and deploying where they could break something. It seems to work: https://raw.github.com/cjdelisle/my-first-xwiki-extension/master/repo/org/xw...
Where I'm hitting a wall is on the import phase, I need to be able to import from an arbitrary m2 repo in order for this technique to work. Is this possible with the EM as it is now?
Well yes EM support any valid maven repository, sometime import takes times when you have a lot of versions. Would need to debug it to understand what's wrong.
Thanks, Caleb
On 01/05/2013 09:34 AM, Vincent Massol wrote:
Hi Caleb,
On Jan 4, 2013, at 8:41 PM, Caleb James DeLisle <[email protected]> wrote:
Hi,
I'm looking to contribute an extension which is installable with the EM and I can't find any documentation on it, if there is no documentation I am willing to write it if someone will walk me through the process.
How do I go about getting published and how are dependencies declared?
3 choices:
1) Your extension is published in a maven repo (e.g. the XWiki public maven repo at http//nexus.xwiki.org). This makes it installable directly by any XE instance. However Maven repos are not searchable so users won't be able to search for your extension and will need to enter the extension id/version in the Advanced Search. 2) Same as 1) but you wish to have your extension searchable. For this, it should be available on extensions.xwiki.org. To do that all you need is to "Import" your extension from the maven repo. This is the "import" action on extensions.xwiki.org 3) Your extension is NOT in a maven repo. You need to contribute it on extensions.xwiki.org and then follow the documentation to add dependencies (basically one object per dep).
Feel free to document this. I think we could have a question mark icon on extensions.xwiki.org just after "Contribute extension" and when you click on it, it would go to a page listing what I've explained above, wdyt?
Thanks -Vincent
_______________________________________________ users mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/users
_______________________________________________ users mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/users
-- Thomas Mortagne
participants (3)
-
Caleb James DeLisle -
Thomas Mortagne -
Vincent Massol