we’re currently working on the onboarding topic on 2 aspects: onboarding of admins with a revamp of the old Distribution Wizard and onbarding of users with a revamp of Tour app for the “Guided tutorial extension”.
As you can see with my introduction here, I’m already using different kind of names and since we’re starting already some implementation we need to stabilize that.
I see two main possibilities for the naming and code structure here:
we consider that both things are about “onboarding” and they might share common code and design, and we reflect that in both naming and hierarchy. So we will have basically “admin onboarding app” and “user onboarding app” and in the code everything under a common `xwiki-platform-onboarding` basically.
we consider that the 2 apps are very different, they don’t share anything and they should have their own naming and different hierarchies in the code. Then we need to decide specifically the name, we could reuse `Distribution Wizard` and `Guided Tutorial Extension` in which case we’d might have things like `xwiki-platform-distributionwizard` and `xwiki-platform-guidedtutorial`.
Personally I have a preference for 1, as I think it gives a common umbrella name and even if there’s not much shared in the code the purpose is globally the same, it’s even the reason why we adressed both subjects at the same time.
I wouldn’t create an “onboarding” business domain because onboarding is very vast and encompasses lots of things, basically everything users see in the first hours. So, everything you see in XWiki is potentially onboarding.
Onboarding is a cross-cutting concept like security, transactions, logging, performance, etc. It’s not a business domain.
So for now -1 from me for 1).
We could still reuse common code.
So +1 for 2.
I’m not against renaming the “Distribution Wizard” too if we think we can find a better name.
BTW right now the DW is located in xwiki-platform-web-templates (in distribution.vm I think) and it would indeed be good to have it in its own module.
Actually the DW is located in xwiki-platform-extension-distribution, the templates are located in xwiki-platform-web-templates because that’s just where all templates used to go.
ah thx, I never remember that I cannot find it because it’s inside xwiki-platform-extensions (I don’t consider it to be related only to extensions, and it’s not).
What would be the difference between xwiki-platform-tour and xwiki-platform-guidedtutorial? For me, the general purpose of the existing tour is the same as what you’re proposing and the proposed library driver.js seems to be a perfect replacement for the outdated bootstrap-tour library so it’s not clear to me why you’re not just modernizing and extended the existing xwiki-platform-tour module. In any case, to me, xwiki-platform-tour and xwiki-platform-guidedtutorial seem to be too close, and I think we shouldn’t have both.
Same note for the distribution wizard, if this should in any way replace the existing distribution wizard, imho, it should be in xwiki-platform-extension-distribution, not xwiki-platform-distributionwizard (I wouldn’t be able to tell the difference from its name).
-1 too for option 1.
+1 to having a new module named xwiki-platform-distribution or xwiki-platform-distributionwizard. I think we can drop the extension part since, afaiu, the new wizard is not specifically about extensions.
I’m not against renaming the existing distribution wizard module to one of the suggested locations, but I think we should make sure we have only one module (with potentially some submodules) and not introduce a new module while keeping the old one in xwiki-platform-extension-distribution.