Page MenuHomePhabricator

Move Vue.js search development over to Gerrit
Open, Needs TriagePublic

Description

Move development from GitHub to Gerrit for for compatibility with workflows (e.g., build step) and improved harmony with the Wikimedia ecosystem.

Acceptance criteria

  • Any URLs (e.g., readme, package.json, wiki) revised to favor Gerrit.
  • No commits harmed in the making of this repo.

Event Timeline

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptFri, May 22, 12:55 AM

May I request to keep the component library hosted in github? So the contribution path is easy, Project is discoverable and hosted in a familiar place for rest of the world to submit issues, fork and submit pull requests and so on?

May I request to keep the component library hosted in github? So the contribution path is easy, Project is discoverable and hosted in a familiar place for rest of the world to submit issues, fork and submit pull requests and so on?

That would make this similar to T252463: Determine how to host Chameleon skin and Bootstrap extension in gerrit while primary development happens in github. (Mirroring from Gerrit to Github would provide the same "discoverability". @santhosh: Is there any data that there are more contributions when the canonical hosting happens in Github instead of Gerrit?)

santhosh added a comment.EditedFri, May 22, 9:44 AM

May I request to keep the component library hosted in github? So the contribution path is easy, Project is discoverable and hosted in a familiar place for rest of the world to submit issues, fork and submit pull requests and so on?

That would make this similar to T252463: Determine how to host Chameleon skin and Bootstrap extension in gerrit while primary development happens in github. (Mirroring from Gerrit to Github would provide the same "discoverability". @santhosh: Is there any data that there are more contributions when the canonical hosting happens in Github instead of Gerrit?)

No, I am not asking to mirror in gerrit or github. Instead, just have the development, issue tracker, release management and CI in github. We are talking about a foundational UI library for Wikimedia and its wider ecosystem based on our learning from OOUI which was developed in gerrit+phabricator and ended up as a uique library used only by Wikimedia. Just trying to avoid that mistake again.

Also, this is only about the UI library. Not about the new search implementation using that library.

@santhosh: Correlation does not imply causation. If OOUI had no marketing that's what happens, no matter where you host it.

Demian added a subscriber: Demian.Fri, May 22, 10:55 AM

May I request to keep the component library hosted in github? So the contribution path is easy, Project is discoverable and hosted in a familiar place for rest of the world to submit issues, fork and submit pull requests and so on?

I wholly empathize with this sentiment. Gerrit hosting is a deterrent for non-wiki.edians to explore the project and to contribute. This and the development culture are probably both reasons for why there's almost no open-source community around MediaWiki.

However, interest in using this library and in return contributing to it depends on whether the provided components give something new and universal - the provided value matters, not the marketing. Looking at the current list of components (code, storybook) I don't see anything that wouldn't be available in an established and more universal library.

IMO the only users of this library will be MediaWiki related projects: third-party skins, extensions, gadgets that want to follow the same style. I wonder how many contributors can be expected from that segment. Enough, so GitHub hosting would have visible benefits? Unfortunately I have no information about that.

Reedy added a subscriber: Reedy.Fri, May 22, 2:19 PM

Mirroring or having the canonical on Github really isn't any different in visibility

May I request to keep the component library hosted in github? So the contribution path is easy, Project is discoverable and hosted in a familiar place for rest of the world to submit issues, fork and submit pull requests and so on?

I wholly empathize with this sentiment. Gerrit hosting is a deterrent for non-wiki.edians to explore the project and to contribute. This and the development culture are probably both reasons for why there's almost no open-source community around MediaWiki.

{{cn}}

WMDE-leszek added a subscriber: WMDE-leszek.EditedMon, May 25, 7:02 AM

Not taking a position in favour of any of options (especially I am not a developer working on this component so I don't even consider having a say here), just sharing something we have learned at WMDE some time ago.

One possible aspect to consider in this context is that Github web UI is arguably more user-friendly/easy to use for the non-developer crowd. This might be relevant here if more-frequent-than-occasional involvement of UX/Design people is intended/predicted/etc.

In one of the first Vue projects at WMDE we had a privilege to have our UX/Design colleague work closely with developers. As long as the codebase was on Github, she was able (via website UI) to e.g. upload assets (SVG files) herself, without redundant relay over developers (e.g. sending asset files via email, requesting particular CSS changes in the conversation etc). This stopped to be a case when the code base was moved to Gerrit, as it is UI was not simple/rich enough to allow submitting changes without using git. I am not be able to provide peer-reviewed research results on this, but from the little data sample we've gathered at WMDE, UX/Design colleagues are eager to be involved in, or at least try out, collaboration with developers on Github, whereas it has been significantly less susccessful when Gerrit is the primary code location.

May I request to keep the component library hosted in github? So the contribution path is easy, Project is discoverable and hosted in a familiar place for rest of the world to submit issues, fork and submit pull requests and so on?

I disagree, first of all, having repo in github doesn't mean easy contribution and it's not correct to assume everyone in github provide easy contribution path:

I think using gerrit is much easier than physically printing a form, scan it, email it and waiting until it gets approved by someone in Oracle. Also, Chromium uses gerrit too and it still has tons of volunteer developers.

The other reason is the connection with the whole technical development infrastructure. I'm currently using github in my project while the issues are being tracked in phabricator. I need to manually connect these two all the time while using gerrit, everything is handled automatically. Not to mention connection of github issues with phabricator, etc.

The third reason for me is security, it's not that gerrit is more secure than github or the other way around but having everything in one place under one account, reduces the attack vector, there's a double chance if either github or gerrit accounts have an account with bad password, no 2fa, etc.

Also I want to say as a person who constantly jumps between gerrit and github, gerrit is not harder, it's just people don't know it. I quite dislike the "Squash and Merge" system of commits in a pull request in Github, instead of that, you can amend a commit over and over again and lose every note and change in between. Gerrit has much better UX (while having ugly UI)

I think using gerrit is much easier than physically printing a form, scan it, email it and waiting until it gets approved by someone in Oracle.

It's the owner's choice how and whether to sign a contributor agreement. Not having to sign a contributor agreement (as done in MediaWiki) is a choice independent from the hosting solution. How is Oracle's flawed (outdated) signing procedure relevant?

Deploying to production requires hosting on gerrit. There are myriad gerrit-specific workflows used for production. Multiple canonical code hosts causes confusion for folks thinking about security, integration, CI, deployments, etc. Mirroring code to github is totally possible to keep a presence there.

Deploying to production requires hosting on gerrit. There are myriad gerrit-specific workflows used for production.

Good point.
Vue requires a build step, which AFAIK is not yet ready in CI: T199004: RFC: Add a frontend build step to skins/extensions to our deploy process
I'd consider doing development in one repo and committing the built library into another. Development being done in GitHub, actions build and commit to gerrit and the usual CI pipeline takes over from there.
I haven't gone into the depth to evaluate the feasibility of this approach, but conceptually I find it possible.

santhosh added a comment.EditedWed, May 27, 11:59 AM

Deploying to production requires hosting on gerrit. There are myriad gerrit-specific workflows used for production. Multiple canonical code hosts causes confusion for folks thinking about security, integration, CI, deployments, etc. Mirroring code to github is totally possible to keep a presence there.

This is only about the frontend library - not mediawiki specific code that need our gerrit workflow. As we know, WMF developed many opensource libraries in github as primary repo and used its CI. These libraries then published to packagist or npm. The frontend library is one such libray and hence my proposal.

Also, apologies if my comment was interpreted as moving Vuejs based search developement to github. I only meant the UI library that will eventually power vuejs based search and other components. More specifically keeping https://github.com/wikimedia/mw-vue-components at github.