Separate out logo handling into square image logos and long text/wordmark banner logos
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	Isarra
	Sep 5 2019, 6:50 PM

Description

Basically, we seem to have three sorts of logo layout:

Long banner/wordmark, in which it's either just the text logo, or an image plus the text logo (Minerva, BlueSky, CologneBlue, Timeless header/on mobile)
Square logo with text/wordmark underneath (MonoBook, Vector)
Square logo one place, text/banner/wordmark elsewhere in interface (Timeless desktop - text in header, square in sidebar, GreyStuff - banner/text in header, square logo in footer, or at least that was the idea...)

By splitting the logo into two distinct images, a square image logo if applicable and a long text/wordmark version, we could thus minimise the number of uploads required for branding different types of skins while consistently supporting all of them:

Assemble the MonoBook/Vector logos by placing a 135-150px square logo image above a 135-150px centered/text wordmark
Allow skins to use only text/wordmark or logo image in different places as appropriate

For backwards compatibility:

Fall back to $wgLogo etc if none of the new stuff is specified (what Timeless currently does for the square sidebar logo)
Fall back to styled text message containing by default (sitetitle) or whatever if no wordmark image is specified (Minerva uses (mobile-frontend-footer-sitename) and Timeless uses (timeless-sitetitle) custom messages as wrappers currently, but we likely do want to standardise this as well)

Developer notes

We'll introduce a wgLogos array which will replace wgLogo and wgLogoHD.

QA steps

ASAP

Confirm a logo shows on https://en.wikipedia.beta.wmflabs.org/wiki/Main_Page
Confirm a logo shows on https://en.m.wikipedia.beta.wmflabs.org/wiki/Main_Page

Using an old device (IE7 on browserstack suggested)

Take a screenshot of the broken logo on https://en.m.wikipedia.beta.wmflabs.org/wiki/Main_Page and attach to this ticket

On Thursday, February 27:

Open Wikipedia, Commons, and Wikidata (in any language) from a modern browser. Confirm there is no changes to the logos.
Open Wikipedia, Commons, and Wikidata (in any language) from IE 8. Take a screenshot of the logo (we are expecting it to look broken)

Sign off notes

Setup a task for a config change to replace MinervaCustomLogos with wgLogos
Setup a task to make a configuration change to merge MinervaCustomLogos, wgLogo and wgLogoHD

QA Results

AC	Status	Details
1	✅	T232140#5931250
2	❓	T232140#5931250
3	❓	T232140#5931250
4	✅	T232140#5931250
5	✅	T232140#5931250

Details

Subject	Repo	Branch	Lines +/-
installer: Write to wgLogos, not wgLogo	mediawiki/core	REL1_35	+21 -10
installer: Write to wgLogos, not wgLogo	mediawiki/core	master	+21 -10
Drop support for $wgMinervaCustomLogos being set	mediawiki/skins/MinervaNeue	master	+2 -108
Restore beta cluster logo on mobile	operations/mediawiki-config	master	+7 -1
Merge $wgLogo and $wgLogoHD into $wgLogos	operations/mediawiki-config	master	+3 K -1 K
Follow-up 8cd2e13: RELEASE-NOTES-1.35: Add new $wgLogos configuration	mediawiki/core	master	+7 -0
Hard-deprecate $wgMinervaCustomLogos being set	mediawiki/skins/MinervaNeue	master	+1 -1
Deprecate wgMinervaCustomLogos in favor of $wgLogos	mediawiki/skins/MinervaNeue	master	+146 -23
Update you-should-set-a-logo reminder to point to $wgLogos, not $wgLogo	mediawiki/core	master	+0 -0
Mobile logo should fall back to PNG if no SVG support	operations/mediawiki-config	master	+3 -1
Use wgLogos['wordmark'], not the removed wgMinervaCustomLogos	mediawiki/extensions/ContentTranslation	master	+6 -15
[doc] [PHP] fix wfDeprecated() description	mediawiki/core	master	+3 -2
Follow-up 51a34809: Don't hard-deprecate something still set in config, you'll break prod	mediawiki/skins/MinervaNeue	master	+1 -1
Drop usage of mediawiki.skinning.interface module in favor of SkinModule	mediawiki/skins/Vector	master	+3 -99
Read from (and write to!) wgLogos, not the deprecated wgLogo	mediawiki/extensions/WikimediaIncubator	master	+9 -4
Correctly use wfDeprecated function signature for wgLogoHD	mediawiki/core	master	+1 -1
Restore wordmark to Vector printed media	mediawiki/core	master	+3 -1
Follow-up 8cd2e13: Setup: Check that 1x key has been set in wgLogos before using	mediawiki/core	master	+1 -1
Set $wgLogos['1x'] (new style access) to $wgLogo (old style access)	operations/mediawiki-config	master	+3 -0
Restore wgLogoHD to wikis without a MinervaCustomLogos defined	operations/mediawiki-config	master	+4 -1
Deprecate access of logos directly from config, introduce wgLogos	mediawiki/core	master	+203 -42
wgLogoHD and $wgVectorPrintLogo is replaced with wgLogos (2/2)	operations/mediawiki-config	master	+12 -2
wgLogoHD and $wgVectorPrintLogo is replaced with wgLogos (1/2)	operations/mediawiki-config	master	+11 -7
Remove the need for Vector's ResourceLoaderLessModule and wgVectorPrintLogo	mediawiki/core	master	+59 -1
Deprecate wgLogo and wgLogoHD	mediawiki/core	master	+0 -0
Drop mediawiki.skinning.interface	mediawiki/skins/Vector	master	+4 -101
Replace wgLogo and wgLogoHD with more generic wgLogos	mediawiki/core	master	+123 -83

Related Objects
Search...

Status	Subtype	Assigned	Task
Resolved	Goal	ovasileva	T242131 [GOAL] Deploy new header to at least one test wiki
Resolved		Jdlrobson	T240856 [EPIC] New header for desktop improvements project
Resolved		ovasileva	T232140 Separate out logo handling into square image logos and long text/wordmark banner logos
Resolved		Jdforrester-WMF	T244370 Beta: Undefined index: 1x in /srv/mediawiki-staging/php-master/includes/Setup.php on line 186
Resolved	PRODUCTION ERROR	Jdlrobson	T244405 PHP Notice: Undefined offset: 1 in ResourceLoaderSkinModule.php
Resolved		Urbanecm	T246535 Minerva logo at cswiki was deleted

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes

Volker_E mentioned this in T245190: Implement guidelines around logos creation.Feb 13 2020, 6:59 PM

In T245182#5882313, @Tgr wrote:

Side note, wfDeprecated is used wrong here:

the third argument is for specifying the extension/library, using it for an extra message like here just adds to the confusion. If it's important (IMO not) put it in the first parameter.

by default caller offset is two, which is appropriate for deprecating a function (the deprecation warning tells which function called the function that calls wfDeprecated). Since it's not ResourceLoaderSkinModule::getAvailableLogos itself that's being deprecated, that's confusing here and a caller offset of 1 should be used.

Jdlrobson moved this task from Needs More Work to Needs Code Review on the Web-Team-Backlog (Kanbanana-2019-20-Q3) board.Feb 14 2020, 7:00 PM

In T232140#5873587, @phuedx wrote:

Moved to Needs More Work as https://gerrit.wikimedia.org/r/#/c/mediawiki/skins/MinervaNeue/+/551670/ is currently V-1.

Linting issue is now fixed. In future if I'm ever away please feel free to fix such linting issues rather than block on me returning.

Thanks for the suggestion on the test I tried incorporated it (PS7) but it didn't work sadly so I've reverted back to temporarily disabling it (PS8)

Change 572308 had a related patch set uploaded (by Jdlrobson; owner: Jdlrobson):
[mediawiki/core@master] Correctly use wfDeprecated function signature for wgLogoHD

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

Change 572322 by @Jdforrester-WMF and @Tgr

[mediawiki/core@master] Follow-up 37a69a2f: ResourceLoaderSkinModule: Fix wfDeprecated() syntax

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

Change 572308 abandoned by Thiemo Kreuz (WMDE):
Correctly use wfDeprecated function signature for wgLogoHD

Reason:
Obsolete via Iadeec95.

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

phuedx moved this task from Needs Code Review to Needs More Work on the Web-Team-Backlog (Kanbanana-2019-20-Q3) board.Feb 19 2020, 11:51 AM

☝️ @Jdlrobson I've left a question about the deprecation notice for wgMinervaCustomLogos not being shown in one scenario.

Jdlrobson moved this task from Needs More Work to Doing on the Web-Team-Backlog (Kanbanana-2019-20-Q3) board.Feb 19 2020, 6:01 PM

Jdlrobson moved this task from Doing to Needs Code Review on the Web-Team-Backlog (Kanbanana-2019-20-Q3) board.Feb 19 2020, 11:40 PM

Change 551670 merged by jenkins-bot:
[mediawiki/skins/MinervaNeue@master] Deprecate wgMinervaCustomLogos in favor of $wgLogos

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

Change 573419 had a related patch set uploaded (by Jdlrobson; owner: Jdlrobson):
[operations/mediawiki-config@master] Mobile logo should fall back to PNG if no SVG support

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

Is there a patch for ContentTranslation? Otherwise this'll emit a bunch of hard deprecation warnings in production.

In T232140#5899644, @gerritbot wrote:

Change 573419 had a related patch set uploaded (by Jdlrobson; owner: Jdlrobson):
[operations/mediawiki-config@master] Mobile logo should fall back to PNG if no SVG support

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

@Jdlrobson Which are the browsers you have in mind here. IE 6-8 shouldn't be our concern here and Android < 3 is also neglible. Falling back to text seems more reasonable here than caring for PNG automation implementation and maintenance.

In T232140#5899645, @Jdforrester-WMF wrote:

Is there a patch for ContentTranslation? Otherwise this'll emit a bunch of hard deprecation warnings in production.

Oh geez i completely missed that ContentTranslation was using this in that way.

https://gerrit.wikimedia.org/g/mediawiki/extensions/ContentTranslation/+/881f4279ab78f95ee34553a75817ae7764baf08f/specials/ContentTranslationSpecialPage.php

My read of the code is that this won't lead to deprecation warnings in production as we are still defining the value in config and ContentTranslation is reading directly from config and catching exceptions not using the Minerva function. We will need to fix that for compatibility however ASAP before we can clean up the config.

ReleaseTaggerBot edited projects, added MW-1.35-notes (1.35.0-wmf.21; 2020-02-25); removed MW-1.35-notes (1.35.0-wmf.19; 2020-02-11).Feb 20 2020, 1:00 AM

Yeah, sorry, was told about that by Krinkle whilst looking at writing config patches myself; see https://gerrit.wikimedia.org/r/c/operations/mediawiki-config/+/572998

Change 572984 had a related patch set uploaded (by Krinkle; owner: Jforrester):
[mediawiki/extensions/WikimediaIncubator@master] Read from (and write to!) wgLogos, not the deprecated wgLogo

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

Change 572984 merged by jenkins-bot:
[mediawiki/extensions/WikimediaIncubator@master] Read from (and write to!) wgLogos, not the deprecated wgLogo

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

Change 573762 had a related patch set uploaded (by Jforrester; owner: Jforrester):
[mediawiki/extensions/ContentTranslation@master] Use wgLogos['wordmark'], not the removed wgMinervaCustomLogos

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

Change 573767 had a related patch set uploaded (by Jforrester; owner: Jforrester):
[mediawiki/skins/MinervaNeue@master] Follow-up 51a34809: Don't hard-deprecate something still set in config, you'll break prod

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

Change 573768 had a related patch set uploaded (by Jforrester; owner: Jforrester):
[mediawiki/skins/MinervaNeue@master] Hard-deprecate $wgMinervaCustomLogos being set

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

Change 573769 had a related patch set uploaded (by Jforrester; owner: Jforrester):
[mediawiki/skins/MinervaNeue@master] Drop support for $wgMinervaCustomLogos being set

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

Change 573816 had a related patch set uploaded (by Niedzielski; owner: Stephen Niedzielski):
[mediawiki/core@master] [doc] [PHP] fix wfDeprecated() description

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

T245182: Use of $wgLogoHD was deprecated in Rename configuration variable to $wgLogos regressed and happened again in .20 in T245778: Spike in "Use of ResourceLoaderSkinModule::getAvailableLogos with $wgLogoHD set instead of $wgLogos was deprecated in MediaWiki 1.35."

Patch merged to master because it hasn't been cleaned up properly for WMF prod

Mentioned in SAL (#wikimedia-operations) [2020-02-21T13:38:15Z] <reedy@deploy1001> Synchronized php-1.35.0-wmf.20/includes/resourceloader/ResourceLoaderSkinModule.php: T245778 T245182 T232140 (duration: 01m 00s)

Jdlrobson moved this task from Needs Code Review to Ready for Signoff on the Web-Team-Backlog (Kanbanana-2019-20-Q3) board.Feb 21 2020, 6:11 PM

@ovasileva important question that needs answer before Tuesday: currently when the new changes roll out we will be dropping support for showing the logo on older devices eg. Android 2, IE6-8. If we want to retain that support I need you to move this into needs more work with a comment. If this is fine you can resolve (or arrange a later QA of logos everywhere).

This change is done. There is some config cleanup to do but that will be done separately outside this ticket.

Change 573767 merged by jenkins-bot:
[mediawiki/skins/MinervaNeue@master] Follow-up 51a34809: Don't hard-deprecate something still set in config, you'll break prod

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

Change 573816 merged by jenkins-bot:
[mediawiki/core@master] [doc] [PHP] fix wfDeprecated() description

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

In T232140#5907656, @Jdlrobson wrote:

@ovasileva important question that needs answer before Tuesday: currently when the new changes roll out we will be dropping support for showing the logo on older devices eg. Android 2, IE6-8. If we want to retain that support I need you to move this into needs more work with a comment. If this is fine you can resolve (or arrange a later QA of logos everywhere).

This change is done. There is some config cleanup to do but that will be done separately outside this ticket.

This is fine. Let's go to QA to capture a screenshot of what they would look like in these browsers, in case this comes up later.

ovasileva updated the task description. (Show Details)Feb 24 2020, 9:15 AM

Change 573762 merged by jenkins-bot:
[mediawiki/extensions/ContentTranslation@master] Use wgLogos['wordmark'], not the removed wgMinervaCustomLogos

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

Jdlrobson updated the task description. (Show Details)Feb 24 2020, 6:11 PM

Jdlrobson updated the task description. (Show Details)

Jdlrobson updated the task description. (Show Details)Feb 24 2020, 6:13 PM

Change 574525 had a related patch set uploaded (by Jforrester; owner: Jforrester):
[mediawiki/core@master] Update you-should-let-a-logo reminder to point to $wgLogos, not $wgLogo

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

Change 573419 abandoned by Jdlrobson:
Mobile logo should fall back to PNG if no SVG support

Reason:
After discussion with Olga and Volker we have decided to no longer support these browsers. Those browsers will see a broken image (img tag pointing to unsupported SVG file)

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

Change 574525 merged by jenkins-bot:
[mediawiki/core@master] Update you-should-set-a-logo reminder to point to $wgLogos, not $wgLogo

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

Jdlrobson moved this task from Incoming to Q3 2019-2020 on the Desktop Improvements (Vector 2022) board.Feb 25 2020, 12:15 AM

ovasileva removed ovasileva as the assignee of this task.Feb 25 2020, 6:06 PM

Jdlrobson assigned this task to Edtadros.Feb 26 2020, 6:08 PM

Change 570379 merged by jenkins-bot:
[operations/mediawiki-config@master] Merge $wgLogo and $wgLogoHD into $wgLogos

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

Mentioned in SAL (#wikimedia-operations) [2020-02-27T00:13:15Z] <jforrester@deploy1001> Synchronized wmf-config/CommonSettings.php: T232140: Stop setting wgLogoHD from wgLogos (duration: 01m 05s)

Mentioned in SAL (#wikimedia-operations) [2020-02-27T00:15:12Z] <jforrester@deploy1001> Synchronized wmf-config/InitialiseSettings.php: T232140: Merge definition of wgLogos and wgLogo (duration: 01m 04s)

Change 573768 merged by jenkins-bot:
[mediawiki/skins/MinervaNeue@master] Hard-deprecate $wgMinervaCustomLogos being set

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

ReleaseTaggerBot edited projects, added MW-1.35-notes (1.35.0-wmf.22; 2020-03-03); removed MW-1.35-notes (1.35.0-wmf.21; 2020-02-25).Feb 27 2020, 11:00 PM

Change 575293 had a related patch set uploaded (by Jforrester; owner: Jforrester):
[mediawiki/core@master] installer: Write to wgLogos, not wgLogo

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

Krinkle added a subtask: T246535: Minerva logo at cswiki was deleted.Feb 29 2020, 5:01 PM

I note that Setup.php and SkinModule still depend on wgLogo by default for transmitting the default logo path. Fixing this is a prerequisite to deprecating wgLogo and (later) removing the consuming code.

Dvorapa subscribed.Feb 29 2020, 5:05 PM

Codesearch: Config::get for "Logo".

It looks like GrowthExperiments/ConfirmEmailHooks.php is still using wgLogo.

Test Result

Status: ✅ PASS
OS: macOS Catalina
Browser: Chrome
Device: MBP
Emulated Device: iPhoneX
Virtual Device: Various Browserstack browsers and Windows OS

Test Artifact(s):

QA steps

Note: I lost the images I had taken previously and on 2/28. The images are from 3/1

✅ AC1: Confirm a logo shows on https://en.wikipedia.beta.wmflabs.org/wiki/Main_Page

❓AC2: Confirm a logo shows on https://en.m.wikipedia.beta.wmflabs.org/wiki/Main_Page
Looks like just text.

❓AC3: Using an old device (IE7 on browserstack suggested)
Take a screenshot of the broken logo on https://en.m.wikipedia.beta.wmflabs.org/wiki/Main_Page and attach to this ticket
Looks like just text. Additionally the page, or for that matter any Wikipedia page prod or beta don't show up on browserstack IE7 and IE6, this might be a Windows XP issue because I get the same on IE8 on Win7, but not Win8.

IE11	IE10	IE9	IE8	IE7 & IE6

On Thursday, February 27 (see note):

✅ AC4: Open Wikipedia, Commons, and Wikidata (in any language) from a modern browser. Confirm there is no changes to the logos.

ENWIKI	ENWIKI-mob	Commons	Commons-mob	Wikidata	Wikidata

✅ AC5: Open Wikipedia, Commons, and Wikidata (in any language) from IE 8. Take a screenshot of the logo (we are expecting it to look broken)

ENWIKI	ENWIKI-mob	Commons	Commons-mob	Wikidata	Wikidata

@ovasileva I have some question marks on some of the acceptance criteria. This could be due to when the images were taken. Everything looks as expected in production.

Thanks @Edtadros! @Jdlrobson - do you know what might have happened to the wordmark on the beta cluster?

Urbanecm closed subtask T246535: Minerva logo at cswiki was deleted as Resolved.Mar 2 2020, 12:16 PM

ovasileva moved this task from Needs QA to Needs More Work on the Web-Team-Backlog (Kanbanana-2019-20-Q3) board.Mar 2 2020, 6:14 PM

Jdlrobson moved this task from Needs More Work to Doing on the Web-Team-Backlog (Kanbanana-2019-20-Q3) board.Mar 2 2020, 6:15 PM

ovasileva removed ovasileva as the assignee of this task.Mar 2 2020, 6:19 PM

Jdlrobson moved this task from Doing to Ready for Signoff on the Web-Team-Backlog (Kanbanana-2019-20-Q3) board.Mar 2 2020, 10:09 PM

Change 576157 had a related patch set uploaded (by Jdlrobson; owner: Jdlrobson):
[operations/mediawiki-config@master] Restore beta cluster logo on mobile

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

The beta cluster logo issue will not impact production. I'll work with @Jdforrester-WMF fix it but it doesn't need to block signing this off.

Sounds good, thanks for looking into it @Jdlrobson. Resolving.

Change 576157 abandoned by Jdlrobson:
Restore beta cluster logo on mobile

Reason:
no longer necessary - logo is back. Thanks James!

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

Krinkle mentioned this in T247020: load.php?modules=startup miss rate tripled on 2020-02-05.Mar 5 2020, 7:29 PM

Change 573769 merged by jenkins-bot:
[mediawiki/skins/MinervaNeue@master] Drop support for $wgMinervaCustomLogos being set

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

ReleaseTaggerBot edited projects, added MW-1.35-notes (1.35.0-wmf.24; 2020-03-17); removed MW-1.35-notes (1.35.0-wmf.22; 2020-03-03).Mar 10 2020, 9:00 PM

@Jdlrobson There are still two unresolved issues:

The default in Setup.php fills in the old deprecated setting, whereas it should (instead, or also) be filing in the new one. Otherwise, the branch in SkinModule for wgLogo can never be deprecated.
The installer generates LocalSettings.php files with assignments for the deprecated setting. (work in progress at https://gerrit.wikimedia.org/r/575293)

@Krinkle my understanding was that we were going to keep wgLogo as an easy configuration option and not actually deprecate it ever.

Either way let's create a new task for any future work so as not to cause confusion about what's remaining.

Jdlrobson mentioned this in T247790: wgLogos follow up work.Mar 16 2020, 8:15 PM

Change 575293 merged by jenkins-bot:
[mediawiki/core@master] installer: Write to wgLogos, not wgLogo

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

Change 616982 had a related patch set uploaded (by Jforrester; owner: Jforrester):
[mediawiki/core@REL1_35] installer: Write to wgLogos, not wgLogo

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

Change 616982 merged by jenkins-bot:
[mediawiki/core@REL1_35] installer: Write to wgLogos, not wgLogo

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

Akuckartz added a project: MediaWiki-Stakeholders-Group.Aug 12 2020, 2:44 PM

Akuckartz subscribed.

	F31654248: T232140-1.png
	Mar 2 2020, 6:49 AM

	F31654326: T232140-enIE8.png
	Mar 2 2020, 6:49 AM

	F31654251: T232140-2.png
	Mar 2 2020, 6:49 AM

	F31654269: T232140-IE7.png
	Mar 2 2020, 6:49 AM

Separate out logo handling into square image logos and long text/wordmark banner logosClosed, ResolvedPublicActions

Description

Developer notes

QA steps

Sign off notes

QA Results

Details

Related ObjectsSearch...

Event Timeline

Test Result

QA steps

Separate out logo handling into square image logos and long text/wordmark banner logos
Closed, ResolvedPublic
Actions

Related Objects
Search...