Page MenuHomePhabricator

[EPIC] Replace WikimediaUI Base variables with Codex design tokens (mediawiki.skin.variables)
Open, HighPublic

Description

Background

Codex design tokens are the fundamentals for consistent interface at Wikimedia Foundation.
They are available in two ways:

  1. Since MW v1.41.0 'mediawiki.skin.variables.less' features Codex design tokens. These are providing a themeable, scalable nomenclature and are following Wikimedia's stylesheet variable naming convention.
  2. As npm package for use cases like MW independent microsites/projects et al.

Related: T332541

Goal

Replace WikimediaUI-Base @imports with 'mediawiki.skin.variables.less' and static values where easily identifiable.

Benefits
  • Reduce design debt
  • Reduce technical debt
  • Ensure that single source of truth is clarified and established with Codex design tokens via skin variables
  • Extension developers benefit from skin aware tokens (vars). Extensions magically adapt to MW skins. The extent is still on extension author (for example only color tokens used, or everything)
Risks
  • The change requires MW v1.41, if your extension is required to be further backwards-compatible, please reach out to find intermediate solutions
  • As with every code change, there's a minimal chance of human error in token application. The patches provided should not result in visual change aside of a few major extension, where the known small changes are flagged.
Acceptance criteria for done

Integrated via package.json dependency

And through OOUI dependency:

Dependent through copy/paste from source repo

  • performance/docroot
  • integration/docroot
  • integration/reporting
  • operations/mediawiki-config

Homebrewed copy/paste of several variables

Related Objects

Event Timeline

Change 909660 had a related patch set uploaded (by VolkerE; author: VolkerE):

[mediawiki/extensions/Kartographer@master] styles: Replace and remove WikimediaUI Base vars with skin variables

https://gerrit.wikimedia.org/r/909660

Restricted Application triaged this task as High priority. · View Herald TranscriptApr 19 2023, 9:04 PM

Change 911950 had a related patch set uploaded (by VolkerE; author: VolkerE):

[mediawiki/extensions/JsonConfig@master] styles: Replace and remove WikimediaUI Base vars with skin variables

https://gerrit.wikimedia.org/r/911950

Change 909660 merged by jenkins-bot:

[mediawiki/extensions/Kartographer@master] styles: Replace and remove WikimediaUI Base vars with skin variables

https://gerrit.wikimedia.org/r/909660

Change 901217 had a related patch set uploaded (by VolkerE; author: VolkerE):

[mediawiki/extensions/GrowthExperiments@master] styles: Replace old variables calls with skin variables

https://gerrit.wikimedia.org/r/901217

Change 912293 had a related patch set uploaded (by VolkerE; author: VolkerE):

[mediawiki/extensions/SearchVue@master] styles: Replace and remove WikimediaUI Base vars with skin variables

https://gerrit.wikimedia.org/r/912293

Change 911950 merged by jenkins-bot:

[mediawiki/extensions/JsonConfig@master] styles: Replace and remove WikimediaUI Base vars with skin variables

https://gerrit.wikimedia.org/r/911950

Change 912293 merged by jenkins-bot:

[mediawiki/extensions/SearchVue@master] styles: Replace and remove WikimediaUI Base vars with skin variables

https://gerrit.wikimedia.org/r/912293

Change 913006 had a related patch set uploaded (by VolkerE; author: VolkerE):

[mediawiki/extensions/MachineVision@master] styles: Replace and remove WikimediaUI Base vars with skin variables

https://gerrit.wikimedia.org/r/913006

Test wiki created on Patch demo by KHarlan (WMF) using patch(es) linked to this task:
https://patchdemo.wmflabs.org/wikis/cfdfa13682/w

Change 914868 had a related patch set uploaded (by VolkerE; author: VolkerE):

[mediawiki/extensions/PasswordlessLogin@master] styles: Replace wrongly included WikimediaUI Base with skin variables

https://gerrit.wikimedia.org/r/914868

Change 913006 merged by jenkins-bot:

[mediawiki/extensions/MachineVision@master] styles: Replace and remove WikimediaUI Base vars with skin variables

https://gerrit.wikimedia.org/r/913006

Change 914010 had a related patch set uploaded (by VolkerE; author: Anne Tomasevich):

[mediawiki/extensions/MachineVision@master] Remove hack for including WikimediaUI base file

https://gerrit.wikimedia.org/r/914010

Change 914010 merged by jenkins-bot:

[mediawiki/extensions/MachineVision@master] Remove hack for including WikimediaUI base file

https://gerrit.wikimedia.org/r/914010

Volker_E renamed this task from Replace WikimediaUI Base variables with mediawiki.skin.variables to [EPIC] Replace WikimediaUI Base variables with mediawiki.skin.variables.May 6 2023, 8:51 PM
Volker_E updated the task description. (Show Details)

Change 901217 merged by jenkins-bot:

[mediawiki/extensions/GrowthExperiments@master] styles: Replace old variables calls with skin variables

https://gerrit.wikimedia.org/r/901217

Change 918626 had a related patch set uploaded (by VolkerE; author: VolkerE):

[mediawiki/extensions/MediaSearch@master] styles, build: Remove WikimediaUI Base dependency and use Codex tokens

https://gerrit.wikimedia.org/r/918626

Change 919414 had a related patch set uploaded (by VolkerE; author: VolkerE):

[mediawiki/extensions/StructuredNavigation@master] styles, build: Replacing WikimediaUI Base by use of Codex tokens

https://gerrit.wikimedia.org/r/919414

Change 919424 had a related patch set uploaded (by VolkerE; author: VolkerE):

[mediawiki/extensions/CodeMirror@master] styles: Replace mentioning of WikimediaUI Base and add skin variables

https://gerrit.wikimedia.org/r/919424

Volker_E added subscribers: CCiufo-WMF, ldelench_wmf.

Taking this off our sprint even with the three active, small changes to different repos, as agreed on in our task refinement today. @CCiufo-WMF @ldelench_wmf

Change 919424 merged by jenkins-bot:

[mediawiki/extensions/CodeMirror@master] styles: Replace mentioning of WikimediaUI Base and add skin variables

https://gerrit.wikimedia.org/r/919424

Change 918626 merged by jenkins-bot:

[mediawiki/extensions/MediaSearch@master] styles, build: Remove WikimediaUI Base dependency and use Codex tokens

https://gerrit.wikimedia.org/r/918626

Volker_E renamed this task from [EPIC] Replace WikimediaUI Base variables with mediawiki.skin.variables to [EPIC] Replace WikimediaUI Base variables with Codex design tokens (mediawiki.skin.variables).Thu, May 18, 8:01 PM

Change 919414 abandoned by VolkerE:

[mediawiki/extensions/StructuredNavigation@master] styles, build: Replacing WikimediaUI Base by use of Codex tokens

Reason:

Extensions seems abandonware right now. Until I5a2424dc8bc5d9ade35963 and further updates are done, this small addition here seems one-way useless.

https://gerrit.wikimedia.org/r/919414