On 11 Feb 2016 at 18:25:26, Eduard Moraru
([email protected](mailto:[email protected])) wrote:
> Hi,
>
> On Thu, Feb 11, 2016 at 6:10 PM, [email protected]
> wrote:
>
> > Hi devs,
> >
> > Now that we’ve voted on the "XWiki Core” concept and that we’ve agreed
> > that the xwiki organization on github should focused on offering core
> > extensions only (and the rest should be moved to contrib) we need to ensure
> > that we use the same terminology everywhere.
> >
> > I’d like to start updating xwiki.org accordingly but first I want to be
> > sure we agree on the terminology:
> >
> > * The "XWiki Runtime”: the XWiki WAR that you get from the various
> > distributions that you can find on xwiki.org. It’s a minimalistic runtime
> > on top of which you can install Extensions. Documentation for it will be
> > available at http://platform.xwiki.org.
> >
>
> The doc for "XWiki Runtime" is available on platform.xwiki.org (not on
> runtime.xwiki.org).... sounds a bit weird to me. Maybe we should create an
> alias for runtime, just in case?
Was thinking about this too but I’m not sure we need a wiki for that. Right now
the install docs are on platform already
(http://platform.xwiki.org/xwiki/bin/view/AdminGuide/Installation).
> Also, the runtime is the result/artefact of building the platform, right?
> It`s what you actually get to install, as a user.
Yes correct.
I have hesitated long and hard on this when I wrote my email. I put XWiki
Runtime, then put XWiki Platform instead and finally went back to XWiki Runtime
since using XWiki Platform would cause confusions IMO (with several meanings).
I found myself using XWiki Platform Runtime anyway in writing. So using
directly XWiki Runtime seems the less ambiguous term for me.
> > * “XWiki Core”: Represents the set of XWiki APIs/sources making up the
> > "XWiki Platform”.
> >
> The sources are available in github in the xwiki-commons, xwiki-rendering
> > and xwiki-platform repositories. More globally can be meant to represent
> > all the sources found in the xwiki github organization.
> >
> > * “XWiki Contrib”: Extensions to the "XWiki Runtime”. Located under the
> > xwiki-contrib organization in github.
> >
> > * The "XWiki Core Development Team” or “XWiki Core Team” (previously
> > called "XWiki Development Team"): the list of committers of the “xwiki"
> > github organization.
> >
> > * “XWiki Platform”: synonymous for “XWiki Core”. Since “XWiki Platform”
> > could also represent the xwiki-platform github repository, it’s better to
> > use “XWiki Core” when wanting to name the full content of the xwiki github
> > organization. For example: “The XWiki Core Development Team works on XWiki
> > Core”…
> >
>
> But we will still be saying that XWiki is a "platform" on which you can
> build your stuff, right?
Yes.
"XWiki Runtime is a runtime-platform onto which you can develop applications
which can be bundled as Extensions.”
> I would prefer not to mix the 2 terms, "Platform" and "Core", since IMO
> "Core" includes "Platform", but not necessarily the other way around.
> Remember that commons and rendering are theoretically stand-alone projects
> which are not directly connected to XWiki. The Platform works with the
> rendering and commons to produce its artefacts but I would no go as far as
> to say that it also includes them and would prefer to use "XWiki Core" for
> that part.
Actually this is what I said: "it’s better to use “XWiki Core” when wanting to
name the full content of the xwiki github organization. For example: “The XWiki
Core Development Team works on XWiki Core”".
I can make 2 bullet points and not say they’re synonymous.
> > * “Flavor”: a set of Extensions (usually with a purpose) that can be
> > installed all together in a XWiki Runtime or when creating a subwiki inside
> > the XWiki Runtime.
> >
> > * The “Default Flavor”: the unique flavor provided by the “XWiki Core
> > Development Team”. Contrib projects and more generally anyone else can
> > contribute other flavors on extensions.xwiki.org. These flavors will
> > appear in the XWiki Platform when you first run it or when you create a new
> > subwiki. The Default Flavor is going to replace “XWiki Enterprise” (and
> > enterprise.xwiki.org will be removed and folded into platform.xwiki.org -
> > the same will happen for xwiki-enterprise which will be folded into
> > xwiki-platform in github)
> >
> > * “XWiki Committers” or “XWiki Team". Vague terms that represent the full
> > set of committers of both the xwiki and xwiki-contrib github organizations.
> >
> > * “XWiki N.P”. Shortcut for the “XWiki Runtime” version N.P (e.g. “XWiki
> > 7.4.1”).
> >
>
> Will probably also be synonymous with "Default Flavor" version N.P since it
> will be synchronized with the "XWiki Runtime”.
For me this is the XWiki Runtime. The Default Flavor is not part of the
runtime. When you execute the runtime you decide which Flavor to use. You don’t
have to use the Default Flavor. You can use other flavors such as the Demo
flavor for example.
> > * The “XWiki Project”. Generic term that includes the work done by XWiki
> > Contrib Committers, XWiki Core Committers and by extensions the work done
> > by the full community of contributors to both xwiki and xwiki-contrib
> > github organizations.
> >
> >
> > Do you agree with this? Any other terms that we should define?
> >
>
> Generally +1 (with the above mentions).
Cool, thanks
-Vincent
> Thanks,
> Eduard
>
>
> >
> > Once agreed I’ll kickstart the work by updating xwiki.org pages by
> > creating a Terminology page and update some existing pages. However it’ll
> > be up to everyone to follow the terminology.
> >
> > Thanks
> > -Vincent
> >
_______________________________________________
devs mailing list
[email protected]
http://lists.xwiki.org/mailman/listinfo/devs
