Directory

⚓ T377862 Disabling Help Panel in the main namespace breaks Structured Editing
Page MenuHomePhabricator

Disabling Help Panel in the main namespace breaks Structured Editing
Closed, ResolvedPublic2 Estimated Story PointsBUG REPORT

Description

Steps to replicate the issue (include links if applicable):

  • As an admin, go to Special:Communityconfiguration/HelpPanel
  • Add (Main) to Namespaces with the help panel disabled in both reading and editing mode and Save changes.
  • Go to Special:Homepage, find an arbitrary Add Link (or add Image) task and click it

What happens?:

Visual Editor loads at the selected page. No Structured Edit appears.

What should have happened instead?:

Structured editing interface appears normally.

Notes

This is happening because HelpPanel::shouldShowHelpPanel() first checks whether the namespace is disallowed via Community Configuration, and only when it is not, it checks whether we're currently in a Suggested Edit mode. In other words, disabling Help Panel in a specific namespace has precedence over being in a structured mode.

Originally reported as T377783: [cswiki betalabs] Structured tasks do not load editing surface .

Acceptance Criteria
When an user selects a suggested edit in Special:Homepage, Help panel is always enabled during that edit session, even when it would be otherwise disabled (based on site configuration and/or user preferences).

Event Timeline

The easiest fix here is to ignore Namespaces with the help panel disabled in both reading and editing mode when we're in the Suggested Edits mode. That way, Help Panel would get enabled for Suggested edits, preventing T377783 from happening again.

Alternatively, we can prevent admins from even selecting (Main) in Namespaces with the help panel disabled in both reading and editing mode. That is more difficult to accomplish, but I can't really think of a reason why someone would want to disable Help Panel in the main namespace (aside from wanting to disable it completely, including in the main namespace).

I'm leaning towards going through the easy route here and always enable Help Panel when in a Suggested Edit (even when it would be disabled otherwise), as Suggested Edits do not really make any sense without Help panel (in fact, as T377783 shows, they do not work without Help panel).

@KStoller-WMF, do you have any thoughts on this?

The easiest fix here is to ignore Namespaces with the help panel disabled in both reading and editing mode when we're in the Suggested Edits mode. That way, Help Panel would get enabled for Suggested edits, preventing T377783 from happening again.

I agree; this seems like the logical solution. I also think it's the better solution for end users: I would prefer we don't limit an Admin configuration option that could have a legit use case.

Thanks Kirsten! In that case, this is now actionable.

KStoller-WMF set the point value for this task to 2.
KStoller-WMF removed Final Story Points.

Change #1084844 had a related patch set uploaded (by Urbanecm; author: Urbanecm):

[mediawiki/extensions/GrowthExperiments@master] Help panel: Disregard namespace config when in Suggested Edits mode

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

Change #1084844 merged by jenkins-bot:

[mediawiki/extensions/GrowthExperiments@master] Help panel: Disregard namespace config when in Suggested Edits mode

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

Etonkovidova subscribed.

Checked in testwiki wmf.2 - works as per the AC:

  • when the Help panel is disabled in (Main) namespace via Special:Communityconfiguration/HelpPanel option, Suggested Edits articles still display the Help panel as usual. The editing surface will load and work as expected.
  • the Help panel won't be present in non-Suggedted Edit articles