[xwiki-devs] [Proposal] Move XE as a flavor, rename it and distribute the platform distribution instead
Hi devs, We have a platform distribution that allows users to pick the flavor they wish to use. However we’re currently not advertising it. Instead we’re currently advertising XE on the xwiki.org download pages. I’m proposing that we change that: * Advertise the platform distribution in the download pages of xwiki.org. We would simply call it “XWiki”, e.g. XWiki 8.3. * Move existing xwiki-platform-distribution/xwiki-platform-flavor into xwiki-platform-distribution/xwiki-platform-flavors/xwiki-platform-flavor-base * Create a new flavor in xwiki-platform-distribution/xwiki-platform-flavors/xwiki-platform-flavor-<new name here> * I’m proposing to name this new flavor "Knowledge Base” (and the module xwiki-platform-distribution/xwiki-platform-flavors/xwiki-platform-flavor-kb) since this is what most users use XWiki for. The idea, initially, would simply be to use the same deps as XE and maybe remove the Blog app (or not). * Stop distributing the XE packagings We’re already well into the XWiki 8.3 dev (M2 is planned for tomorrow Monday) so it seems a bit ambitious to do this for 8.3. We could do it for 8.4 though. WDYT? Outstanding questions: * How do we upgrade existing users using XE? WDYT? Thanks -Vincent
For the record, applying this will make impossible to install XE (XWiki + KB flavor) without Internet. Thanks 2016-09-11 19:33 GMT+02:00 Vincent Massol <[email protected]>:
Hi devs,
We have a platform distribution that allows users to pick the flavor they wish to use. However we’re currently not advertising it. Instead we’re currently advertising XE on the xwiki.org download pages.
I’m proposing that we change that: * Advertise the platform distribution in the download pages of xwiki.org. We would simply call it “XWiki”, e.g. XWiki 8.3. * Move existing xwiki-platform-distribution/xwiki-platform-flavor into xwiki-platform-distribution/xwiki-platform-flavors/xwiki- platform-flavor-base * Create a new flavor in xwiki-platform-distribution/ xwiki-platform-flavors/xwiki-platform-flavor-<new name here> * I’m proposing to name this new flavor "Knowledge Base” (and the module xwiki-platform-distribution/xwiki-platform-flavors/xwiki-platform-flavor-kb) since this is what most users use XWiki for. The idea, initially, would simply be to use the same deps as XE and maybe remove the Blog app (or not). * Stop distributing the XE packagings
We’re already well into the XWiki 8.3 dev (M2 is planned for tomorrow Monday) so it seems a bit ambitious to do this for 8.3. We could do it for 8.4 though. WDYT?
Outstanding questions: * How do we upgrade existing users using XE?
WDYT?
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project
On 12 Sep 2016, at 10:27, Guillaume Delhumeau <[email protected]> wrote:
For the record, applying this will make impossible to install XE (XWiki + KB flavor) without Internet.
Indeed. Note that there’s currently a similar issue when upgrading. I don’t think we should stop the flavor concept because of this though. However, if we wish to support offline, I see 2 options: 1) Also offer a Flavor distribution (i.e the equivalent of our current XE distribution) but don’t advertise it as visibly as the platform distribution (only advertise it as an offline solution) 2) Package a local maven repository as a zip and put in it all dependencies that are required over the platform distribution for the “XE” flavor. The user who wants offline would download it, unzip it somewhere and configure his XWiki instance to use it. One solution I’ve already proposed (can’t find the mail link FTM) is to preconfigure xwiki.properties with a local extension repo inside the permanent directory, so the user would just need to unzip it inside the right directory. My preference goes to 2). I don’t know how hard it would be to write a pom.xml to generate it but it should be doable (at worse with all deps including the platform ones). WDYT? Thanks -Vincent
Thanks
2016-09-11 19:33 GMT+02:00 Vincent Massol <[email protected]>:
Hi devs,
We have a platform distribution that allows users to pick the flavor they wish to use. However we’re currently not advertising it. Instead we’re currently advertising XE on the xwiki.org download pages.
I’m proposing that we change that: * Advertise the platform distribution in the download pages of xwiki.org. We would simply call it “XWiki”, e.g. XWiki 8.3. * Move existing xwiki-platform-distribution/xwiki-platform-flavor into xwiki-platform-distribution/xwiki-platform-flavors/xwiki- platform-flavor-base * Create a new flavor in xwiki-platform-distribution/ xwiki-platform-flavors/xwiki-platform-flavor-<new name here> * I’m proposing to name this new flavor "Knowledge Base” (and the module xwiki-platform-distribution/xwiki-platform-flavors/xwiki-platform-flavor-kb) since this is what most users use XWiki for. The idea, initially, would simply be to use the same deps as XE and maybe remove the Blog app (or not). * Stop distributing the XE packagings
We’re already well into the XWiki 8.3 dev (M2 is planned for tomorrow Monday) so it seems a bit ambitious to do this for 8.3. We could do it for 8.4 though. WDYT?
Outstanding questions: * How do we upgrade existing users using XE?
WDYT?
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
On Sun, Sep 11, 2016 at 7:33 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
We have a platform distribution that allows users to pick the flavor they wish to use. However we’re currently not advertising it. Instead we’re currently advertising XE on the xwiki.org download pages.
I’m proposing that we change that: * Advertise the platform distribution in the download pages of xwiki.org. We would simply call it “XWiki”, e.g. XWiki 8.3. * Move existing xwiki-platform-distribution/xwiki-platform-flavor into xwiki-platform-distribution/xwiki-platform-flavors/xwiki-platform-flavor-base * Create a new flavor in xwiki-platform-distribution/xwiki-platform-flavors/xwiki-platform-flavor-<new name here>
* I’m proposing to name this new flavor "Knowledge Base” (and the module xwiki-platform-distribution/xwiki-platform-flavors/xwiki-platform-flavor-kb) since this is what most users use XWiki for. The idea, initially, would simply be to use the same deps as XE and maybe remove the Blog app (or not).
If it's the same as XE it means having a platform package depending on various Contrib extensions.
* Stop distributing the XE packagings
We’re already well into the XWiki 8.3 dev (M2 is planned for tomorrow Monday) so it seems a bit ambitious to do this for 8.3. We could do it for 8.4 though. WDYT?
This is not doable in 8.3 IMO.
Outstanding questions: * How do we upgrade existing users using XE?
Here is what would be the current situation if we don't do anything special: 1) [FS] the user replace the XE WAR with the XWiki one and restart 2) [DW] a flavor is already installed (XE) so DW do nothing in the Flavor Step 3) [DW] Extensions Step cannot find any valid org.xwiki.enterprise:xwiki-enterprise-ui-mainwiki version so it does nothing 4) [EM] you have to go to EM and install "Knowledge Base" flavor which will replace XE flavor (because we make XE flavor a feature of "Knowledge Base" flavor) Then there is various ways to help. = Improve 2) Flavor step The official way to improve this use case is supposed to be to finish http://jira.xwiki.org/browse/XWIKI-12148 for which there is already a place holder in the code which is supposed to do the following: * if there is already a flavor and it's invalid: a) try to find a new valid version for it b) if none can be found propose other valid flavors When we have that we can improve again a bit. == Help step a) ** use Maven reallocation mechanism which in practice mean actually release a "virtual" artifact with old XE group idea forever ** or decide to make e.x.o. support several secondary ids for the same extension, meaning that if you try to resolve org.xwiki.enterprise:xwiki-enterprise-ui-mainwiki 9.0 on it you actually end up with extension org.xwiki.platform:xwiki-patform-flavor-kb 9.0 This also mean making EM aware that it might not receive what it asked for and also deal with the WTF effect this might cause. == Help step b) ** just document the fact that "Knowledge Base" is the new name for "XWiki Enterprise" either in the summary or in the name itself with something like "Knowledge Base (new XWiki Enterprise)". Doing it only during the 9.x cycle or more for example and then stop. = Improve 3) Extensions Step If we don't do http://jira.xwiki.org/browse/XWIKI-12148 and we just do what is described in "Help step a)" section then "Knowledge Base" extension will be proposed as a valid upgrade of the extension XE flavor in the Extensions Step of the DW.
WDYT?
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne
On Sun, Sep 11, 2016 at 8:33 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
We have a platform distribution that allows users to pick the flavor they wish to use. However we’re currently not advertising it. Instead we’re currently advertising XE on the xwiki.org download pages.
I’m proposing that we change that: * Advertise the platform distribution in the download pages of xwiki.org. We would simply call it “XWiki”, e.g. XWiki 8.3. * Move existing xwiki-platform-distribution/xwiki-platform-flavor into xwiki-platform-distribution/xwiki-platform-flavors/xwiki- platform-flavor-base * Create a new flavor in xwiki-platform-distribution/ xwiki-platform-flavors/xwiki-platform-flavor-<new name here> * I’m proposing to name this new flavor "Knowledge Base” (and the module xwiki-platform-distribution/xwiki-platform-flavors/xwiki-platform-flavor-kb) since this is what most users use XWiki for. The idea, initially, would simply be to use the same deps as XE and maybe remove the Blog app (or not). * Stop distributing the XE packagings
We’re already well into the XWiki 8.3 dev (M2 is planned for tomorrow Monday) so it seems a bit ambitious to do this for 8.3. We could do it for 8.4 though. WDYT?
Outstanding questions: * How do we upgrade existing users using XE?
Can we make the new KB flavor ids as an alias of the old XE id? Just like we declare the properties section in the pom (not sure if it's possible, but this way the EM won't see it as something different, but just as something renamed). Thanks, Caty
WDYT?
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
On 12 Sep 2016, at 17:12, Ecaterina Moraru (Valica) <[email protected]> wrote:
On Sun, Sep 11, 2016 at 8:33 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
We have a platform distribution that allows users to pick the flavor they wish to use. However we’re currently not advertising it. Instead we’re currently advertising XE on the xwiki.org download pages.
I’m proposing that we change that: * Advertise the platform distribution in the download pages of xwiki.org. We would simply call it “XWiki”, e.g. XWiki 8.3. * Move existing xwiki-platform-distribution/xwiki-platform-flavor into xwiki-platform-distribution/xwiki-platform-flavors/xwiki- platform-flavor-base * Create a new flavor in xwiki-platform-distribution/ xwiki-platform-flavors/xwiki-platform-flavor-<new name here> * I’m proposing to name this new flavor "Knowledge Base” (and the module xwiki-platform-distribution/xwiki-platform-flavors/xwiki-platform-flavor-kb) since this is what most users use XWiki for. The idea, initially, would simply be to use the same deps as XE and maybe remove the Blog app (or not). * Stop distributing the XE packagings
We’re already well into the XWiki 8.3 dev (M2 is planned for tomorrow Monday) so it seems a bit ambitious to do this for 8.3. We could do it for 8.4 though. WDYT?
Outstanding questions: * How do we upgrade existing users using XE?
Can we make the new KB flavor ids as an alias of the old XE id? Just like we declare the properties section in the pom (not sure if it's possible, but this way the EM won't see it as something different, but just as something renamed).
Yes, Thomas has given more details in his answer. Thanks -Vincent
Thanks, Caty
WDYT?
Thanks -Vincent
Hi, General +1 for the direction. Thanks, Eduard On Mon, Sep 12, 2016 at 6:39 PM, Vincent Massol <[email protected]> wrote:
On 12 Sep 2016, at 17:12, Ecaterina Moraru (Valica) <[email protected]> wrote:
On Sun, Sep 11, 2016 at 8:33 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
We have a platform distribution that allows users to pick the flavor they wish to use. However we’re currently not advertising it. Instead we’re currently advertising XE on the xwiki.org download pages.
I’m proposing that we change that: * Advertise the platform distribution in the download pages of xwiki.org. We would simply call it “XWiki”, e.g. XWiki 8.3. * Move existing xwiki-platform-distribution/xwiki-platform-flavor into xwiki-platform-distribution/xwiki-platform-flavors/xwiki- platform-flavor-base * Create a new flavor in xwiki-platform-distribution/ xwiki-platform-flavors/xwiki-platform-flavor-<new name here> * I’m proposing to name this new flavor "Knowledge Base” (and the module xwiki-platform-distribution/xwiki-platform-flavors/xwiki- platform-flavor-kb) since this is what most users use XWiki for. The idea, initially, would simply be to use the same deps as XE and maybe remove the Blog app (or not). * Stop distributing the XE packagings
We’re already well into the XWiki 8.3 dev (M2 is planned for tomorrow Monday) so it seems a bit ambitious to do this for 8.3. We could do it for 8.4 though. WDYT?
Outstanding questions: * How do we upgrade existing users using XE?
Can we make the new KB flavor ids as an alias of the old XE id? Just like we declare the properties section in the pom (not sure if it's possible, but this way the EM won't see it as something different, but just as something renamed).
Yes, Thomas has given more details in his answer.
Thanks -Vincent
Thanks, Caty
WDYT?
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
participants (5)
-
Ecaterina Moraru (Valica) -
Eduard Moraru -
Guillaume Delhumeau -
Thomas Mortagne -
Vincent Massol