Page MenuHomePhabricator

Edit check: provide simple config to disable a check
Closed, ResolvedPublic

Description

You can currently hack this by adjusting the config to be impossible to fulfill (maximumEditcount: -1), but as we're considering deploying some checks disabled-by-default and toggleable via communities we should provide something that makes this explicit.

Stories

  • As experienced volunteers who have come to agree that a particular Edit Check A) could benefit the project we contribute to or B) is causing disruption, I want to be able to turn individual edit checks on/off on a per project basis, so that I can increase the likelihood that people are publishing constructive edits.
  • As a member of the Editing Team, I'd like to be able to deploy Edit Checks to all wikis by default and for their availability to be configurable on-wiki so that A) I do not need to hold the state of various configurations in my mind on an ongoing basis and B) volunteers can be empowered to decide what Checks are available based on the impact they are causing.

Requirements

  • A new per-check config variable called enabled will be added.
  • Editing MediaWiki:Editcheck-config.json and adding it to one of the check sections as enabled: false should stop that check from ever being shown. (Or enabled: true to turn on a check whose default state is disabled, though none of those currently exist.)
  • ecenable=1/2 will still bypass this and enable the check, just how the account/editcount settings behave.

Done

Event Timeline

Change #1184890 had a related patch set uploaded (by DLynch; author: DLynch):

[mediawiki/extensions/VisualEditor@master] Edit check: add a config that explicitly turns a check on or off

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

Change #1184890 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Edit check: add a config that explicitly turns a check on or off

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

Change #1190717 had a related patch set uploaded (by DLynch; author: DLynch):

[mediawiki/extensions/VisualEditor@master] Edit check: update some check-creation for config changes

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

Change #1190717 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Edit check: update some check-creation for config changes

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

DLynch added a project: Editing QA.
DLynch moved this task from Code Review to QA on the Editing-team (Kanban Board) board.

The testing for this is going to be partially covered by the testing in T404914. That said, since this isn't paste-specific, you should also check whether you can disable a normally-enabled check like add-reference. (Do note: ecenable will bypass this config.)

The enabled/disabled state of a check should not affect the related instrumentation. E.g. the VEFU/tagging for references should still happen even if add-reference is disabled.

Ryasmeen edited projects, added: Verified; removed: Editing QA.