Move Cristal from Contrib to XWiki proper

Development
1

Hi devs,

So far Cristal has been a contrib project but it has progressed well and I believe it’s now ready to be considered as a top-level project of the xwiki.org forge, similar to XS.

Thus this vote is about agreeing to do this.

What does this mean precisely:

  • Move it from https://github.com/xwiki-contrib/cristal to https://github.com/xwiki/cristal. Actually I’m proposing to rename it to xwiki-cristal to be more consistent with the other repos there, see XWiki · GitHub
  • It’d be managed by the XWiki Core Developers (who manage the XWiki GH organization, see https://dev.xwiki.org/xwiki/bin/view/Community/Committership fo details.
    • This could cause some lack of productivity for @pjeanjean who currently doesn’t always go through a PR for Cristal (AFAIU, he pushes directly for small changes). I think it has no impact for @ClementEXWiki since he currently always goes through PRs. We need to know from @pjeanjean if that would be a problem (until he becomes a committer at least - same for Clement).
  • The Download/Try buttons need to to propose Cristal distributions
  • The links in the horizontal menu on xwiki.org will need to be checked and refactored to work not just for XS for also for Cristal
    • For example the News should include all projects of the xwiki.org forge (and the do already)
    • The Roadmap page would list roadmaps for all projects (it already does)
    • Same for the Support one, Contributing one, etc
    • The Documentation menu entry would be transformed into a dropdown with 2 projects: XS and Cristal.
  • Note: We’re currently discussing where to put our docs in some doc reorganization threads on this forum and the idea is to have a top level doc space for each project: one for XS and one for Cristal.
  • cristal.xwiki.org would disappear. We could keep it for a while and provide links for all topics on the home page, with an explanation that it’s been moved.
  • Modify the sources of Cristal to remove any mention of “contrib”.

WDYT?

Here’s my +1

Thx

PS: There’s no timeline mentioned, and if we agree, it would happen at the right time for the Cristal team (but not

2

I don’t think this is pertinent, the other repos are actually parts or are related to the XWiki project, while Cristal can technically be deployed without any relation to XWiki.

It should not have that much impact, the only times I’m not going through a PR is when I am pushing fixes unrelated to issues (e.g., test fixes and test improvements), which does not happen that often to be honest.

Other than that, I’m +1 with all the points.
Thanks.

3

Yes, I thought about this but I think you’re mixing the XWiki open source project which is a forge that hosts projects around the concept of wikis, with XS (or XWiki) which is a project itself (a distribution).

For me the xwiki- prefix is about the fact that it belongs to the XWiki open source project, especially when published in the wild, when you’re outside of the XWiki.org context (think about npm or maven central repos for ex).

For example xwiki-jenkins-pipeline is not about XS. All contrib projects are using it, but it has the xwiki- prefix.

4

+1

5

To make it even more clear and to take an analogy, you can talk about Maven but in reality the full name is Apache Maven (because Apache is the forge).

For Cristal it’s the same, you can talk about Cristal but the real name is XWiki Cristal. This is true even before this proposal, and for all contrib projects. They all belong to the XWiki forge.

You can also see this in Cristal code, for example: import type { WikiConfig } from "@xwiki/cristal-api";

So to conclude:

  • Cristal can be deployed independently of XS
  • But Cristal has a relation to XWiki, it’s an XWiki project (and thus its full name is XWiki Cristal)
6

+1

Thanks,
Marius

7

+1 thanks