Extension:AutoModerator/Deploying

This page provides details on the steps required, both from the Wikimedia Foundation and communities, to enable AutoModerator on a Wikimedia project.

Please note that AutoModerator currently only supports Wikipedia projects.

0. Community consensus

edit

Before deploying AutoModerator on a Wikimedia project, we would like to see some indication from the community of this project that they are enthusiastic about enabling the extension. This does not need to be in the form of a formal RfC, but we want to know that there are enough interested editors that local consensus on configuration can be reached, and there will be sufficient oversight of workflows such as false positive report reviewing.

Once there is consensus to enable AutoModerator on your project, please file a Phabricator task so that the following steps can be tracked. As your community goes through each of the steps, they can be marked as completed in the task.

Wikis where StructuredDiscussions/Flow is used are not generally eligible for deployment at this time, but please feel free to still file a Phabricator ticket so that we can track your request and let you know when this limitation has been lifted.

1. Username and localisation

edit

AutoModerator's username must be selected before the extension can be enabled. The username must not currently be in use by another account, but will be reserved once AutoModerator is configured, such that no other user could register with the same username. You can use the name 'Automoderator' if it makes sense in your language.

Username recommendations:

  • Don't make the username too long.
  • Don't use accusatory words like 'vandalism', or martial words like 'fighter'.
  • Make it clear that the account is automated, or a bot.

There are a small number of strings to localise for AutoModerator on translatewiki

Please make note of the desired username in the Phabricator ticket. The username cannot be changed easily - if you want to change the username in the future, please file a new Phabricator ticket.

2. Create AutoModerator's user page

edit

AutoModerator will take actions from an account, using the username configured in the previous step. This account can have a user page, which should be created before AutoModerator is enabled. We have created the following template which you can localise to your language directly, and/or modify as decided by your community:

Syntax for the user page

Copy the following text to Automoderator's userpage, and translate it.

__NOEDITSECTION__
=== What is Automoderator? ===
Automoderator is an automated system which uses a machine learning model to identify and revert potentially bad edits to ensure Wikipedia remains reliable and trustworthy. Because the model is not perfect, it sometimes reverts good edits; these reverts can be undone directly or reported as false positives. Automoderator’s behaviour is configured by the administrators of this Wikimedia project.

=== Configure ===
Administrators can configure Automoderator, including turning it on or off, at any time. 

[[MediaWiki:AutoModeratorConfig.json|<span class="mw-ui-button mw-ui-neutral" role="button" aria-disabled="false">Configure Automoderator</span>]]

[[mw:Special:MyLanguage/Moderator_Tools/Automoderator|Learn more]] about the Automoderator project and the teams behind it. <!-- This link goes to Mediawiki. Please keep this link as it is -->

=== Help us improve Automoderator ===
<div style="display: flex; flex-wrap: wrap; gap: 1em;">

<div style="flex: 1 1 150px; background: #ffffff; padding: 14px 16px 14px 16px; border: 1px solid #c8ccd1; border-radius: 1px; text-align: align-left;">
<div style=" display: inline-block;"> [[File:OOjs UI icon feedback-ltr.svg|frameless|18x18px|link=]]</div>  '''Give feedback'''

The Moderator Tools team wants to hear your thoughts! Reach out to us through <span class="plainlinks">[https://www.mediawiki.org/wiki/Talk:Moderator_Tools/Automoderator?action=edit&section=new&dtpreload=1&nosummary=true&preload=&preloadtitle=Feedback%20from%20%7B%7Bsubst:REVISIONUSER%7D%7D our talk page]</span>.
<!-- This link goes to Mediawiki. Please keep this link as it is -->

</div>
<div style="flex: 1 1 150px; background: #ffffff; padding: 14px 16px 14px 16px; border: 1px solid #c8ccd1; border-radius: 1px; text-align: align-left;">
<div style=" display: inline-block;"> [[File:OOjs UI icon flag-ltr.svg|frameless|18px|link=]]</div> '''Report a false positive'''

If Automoderator reverted an edit that you think was '''not''' supposed to be reverted, please [[User:AutoModeratorTest/False positives|report a false positive]]. 
<!-- This link goes to the false positive report page at your wiki. Please edit this link accordingly, when the reporting page is setup. -->
</div>
</div>

3. Create false positive reporting page

edit

AutoModerator will not be perfect, and will sometimes revert good edits. Communities will therefore need to set up a false positive reporting and review workflow, so that new editors can report AutoModerator's mistakes for review by experienced editors. This will also require local experienced editors to monitor the page so that good edits can be reinstated - please ensure that at least a few editors have added this page to their watchlist.

We have created a basic page template to facilitate this workflow, where users can create a new section to report a false positive:

Syntax for the reporting page (with a preload)

Copy the following text to Automoderator's false report page. This page has a link from the user page. Please translate it. There is also a preload page to create.

<big>'''Help us improve Automoderator'''</big>

<div style="display: flex; flex-wrap: wrap; gap: 1em;"><div style="flex: 1 1 150px; background: #ffffff; padding: 14px 16px 14px 16px; border:var(--border-subtle,1px solid #c8ccd1); text-align: align-left;"><div style=" display: inline-block;">[[File:OOjs UI icon flag-ltr.svg|frameless|18x18px]]  '''Report a false positive '''</div>

If Automoderator reverted an edit that you think was '''not''' supposed to be reverted, please report a false positive.

<div style="text-align: right;">
<span class="plainlinks">[{{fullurl:{{FULLPAGENAME}}|action=edit}}&section=new&dtpreload=1&nosummary=true&preloadtitle=Report%20by%20%7B%7Bsubst:REVISIONUSER%7D%7D&preload={{urlencode:User:{{PAGENAME}}/Preload}} <span class="mw-ui-button mw-ui-progressive" role="button" aria-disabled="false">Report false positive]</span></span>
</div>
</div>
<div style="flex: 1 1 150px; background: #ffffff; padding: 14px 16px 14px 16px; border:var(--border-subtle,1px solid #c8ccd1); text-align: align-left;"><div style=" display: inline-block;"> [[File:OOjs UI icon feedback-ltr.svg|frameless|18x18px]]  '''Give feedback'''</div>

The Moderator Tools team wants to hear your thoughts! Reach out to us through our talk page.

<div style="text-align: right;">
<span class="plainlinks">[https://www.mediawiki.org/wiki/Talk:Moderator_Tools/Automoderator?action=edit&section=new&dtpreload=1&nosummary=true&preload=&preloadtitle=Feedback%20from%20%7B%7Bsubst:REVISIONUSER%7D%7D <span class="mw-ui-button mw-ui-neutral" role="button" aria-disabled="false">Give feedback]</span></span>
</div>

</div>
</div>

[[User:{{PAGENAME}}/Preload|Create the preload page]]. When done, please remove this line.

Syntax for the preload page:

; Page and diff 
: Please link to the page where Automoderator reverted your edit, and the diff if you can. 
; Description 
: Please describe why your edit should have not been reverted by Automoderator.

Please make note of the false positive reporting page location in the Phabricator ticket.

4. MediaWiki configuration

edit

At this stage, the Moderator Tools team has all the information they need to enable AutoModerator on your project. A patch will be submitted to configure the necessary information and we will let you know when AutoModerator is available for local configuration.

5. Local configuration

edit

AutoModerator can now be locally configured and enabled by administrators. Please see Extension:AutoModerator#On-wiki_configuration for guidance.

6. Adjust threshold

edit

Currently, the threshold above which AutoModerator will revert an edit is only defined in its internal configuration, and is set at 0.99. If you would like to adjust this threshold, please file a Phabricator ticket. In the future, this value will be configurable locally by administrators.