Setup Repo for recommendation experimentation
Closed, ResolvedPublic3 Estimated Story Points
Actions

Assigned To

Authored By

	NBaca-WMF
	Jul 29 2024, 5:01 PM

Description

Background

We need to host code for our recommendation experiments. This code should live in a place that allows for code review, deployment, and has a hook into hosting.

User story

As an engineer on the Web Team, I'd like to setup a repository for testing purposes that we can later use to build and deploy our code that is separate from the core wiki source.

Requirements

Basic README.md
Set up CI tools, eg (depending on source lang)
- linting eg phpcs / parallel-lint
- unit testing, eg. phpunit
- js linting, eg. eslint
- style linting, eg stylelint
- anything relevant for translation, eg. banana-checker

Acceptance criteria

Repo has been set up and is live
README has been written with context
Basic CI/CD has been setup to build source on push

Communication criteria - does this need an announcement or discussion?

Rollback plan

This task was created by Version 1.2.0 of the Web team task template using phabulous

Related Objects
Search...

Status	Subtype	Assigned	Task
Open	Design	None	T370209 [EPIC] Experiment: Display article recommendations in more prominent locations
Open	Design	None	T370521 [EPIC] Test UI of recommendations in the empty state of search and compare to other locations
Resolved	Design	Jdrewniak	T371230 [Spike 1 day] Identify delivery mechanism of experiment pt 1
Resolved	Design	Jdrewniak	T372638 Build empty state of search experiment
Resolved	Design	Jdrewniak	T371294 [Spike 2 days] Identify delivery mechanism pt 2
Resolved		Jdlrobson	T371286 Setup Repo for recommendation experimentation
Resolved	Design	bwang	T372780 Instrument empty state of search experiment
Resolved		Jdlrobson	T373623 Upload experimental chrome extension to Chrome store

Event Timeline

NBaca-WMF created this task.Jul 29 2024, 5:01 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJul 29 2024, 5:01 PM

ovasileva edited projects, added Web-Team-Backlog (FY2024-25 Q1 Sprint 3); removed Web-Team-Backlog.Jul 29 2024, 5:34 PM

ovasileva added a project: FY2024-25 KR 3.1 Content Discovery.

ovasileva added a parent task: T370521: [EPIC] Test UI of recommendations in the empty state of search and compare to other locations.

ovasileva triaged this task as High priority.Jul 29 2024, 5:37 PM

Jdlrobson claimed this task.Jul 31 2024, 7:52 PM

Unassigning since I'll be OOO.
I think we might benefit from more clarity on T371294 before analysing this one.

ovasileva added a parent task: T371294: [Spike 2 days] Identify delivery mechanism pt 2.Aug 5 2024, 5:36 PM

ovasileva edited projects, added Web-Team-Backlog (FY2024-25 Q1 Sprint 4); removed Web-Team-Backlog (FY2024-25 Q1 Sprint 3).

ovasileva moved this task from Needs analysis to Ready for estimation on the Web-Team-Backlog (FY2024-25 Q1 Sprint 4) board.Aug 19 2024, 7:18 AM

ovasileva set the point value for this task to 3.Aug 19 2024, 6:20 PM

ovasileva moved this task from Ready for estimation to Ready for Development on the Web-Team-Backlog (FY2024-25 Q1 Sprint 4) board.Aug 19 2024, 6:31 PM

Jdrewniak claimed this task.Aug 19 2024, 9:02 PM

Jdrewniak moved this task from Ready for Development to Doing on the Web-Team-Backlog (FY2024-25 Q1 Sprint 4) board.

Jdrewniak mentioned this in T372854: Create new GitLab project group: Web team.Aug 20 2024, 2:30 AM

The repo for an experimental browser extension has been set up here:
https://gitlab.wikimedia.org/repos/web/web-experiments-extension
The setup is based on CRXjs + Vite. CRX is a library that helps build chrome extensions. It comes with a nifty Vite plugin that enables hot module reloading the extension in the browser.
I've added the following dev dependencies

ESlint & Stylelint (with wikimedia configs)
Vue & Codex
Readme for getting started.

Still on the todo list is CI integration for tests, and eventually, CI integration for publishing to the Chrome web store.

Jdrewniak removed Jdrewniak as the assignee of this task.Aug 26 2024, 5:26 PM

Jdrewniak moved this task from Doing to Ready for Signoff on the Web-Team-Backlog (FY2024-25 Q1 Sprint 4) board.

Jdrewniak subscribed.

ovasileva assigned this task to Jdlrobson.Aug 26 2024, 5:27 PM

jdrewniak opened https://gitlab.wikimedia.org/repos/web/web-experiments-extension/-/merge_requests/1

Run npm test on pre-commit and during CI

jdrewniak merged https://gitlab.wikimedia.org/repos/web/web-experiments-extension/-/merge_requests/1

Run npm test on pre-commit and during CI

jdrewniak opened https://gitlab.wikimedia.org/repos/web/web-experiments-extension/-/merge_requests/2

Setup CI job to auto-generate a CREDITS file

jdrewniak merged https://gitlab.wikimedia.org/repos/web/web-experiments-extension/-/merge_requests/2

Setup CI job to auto-generate a CREDITS file

Suggest updating the README to expand on the scope of this repo - whether it's just one experiment or can be used for future experiments. Possibly some guidance on whether code should be tested on mobile as well as desktop domain.

@Jdlrobson I just added the following to the README.md
https://gitlab.wikimedia.org/repos/web/web-experiments-extension/-/blob/main/README.md?ref_type=heads

Description
This browser extension was made to test and gather feedback on experimental features created by the Web team at the Wikimedia foundation.
It currently includes only the following experiment, but, it is built to accommodate future experiments as well.

T370521 - Empty search state on Vector 2022

Due to the relative obscurity of browser extensions on mobile, this extension is best suited for experiments targeting desktop Wikipedia, however, experiments can be written to target the mobile domain if desired.

Perfect! Thank you!

Setup Repo for recommendation experimentationClosed, ResolvedPublic3 Estimated Story PointsActions