Extension:GrowthExperiments/developer setup

Installation
Other extensions (optional)


 * PageImages — Used in link recommendation tasks (for showing images from the corresponding link recommendation articles).
 * Instrumentation — For more information, see Wikitech
 * EventLogging
 * EventStreamConfig
 * EventBus
 * WikiEditor — The default source editor.
 * Campaigns — Used to track entry points for account creation.
 * WikimediaEvents — Used for some of the editing-related instrumentation.
 * GuidedTour — Used to show tooltips (currently on desktop only).
 * CLDR — Used for localizing language names.

Enabling Growth features

 * 1) Go to Special:Preferences (while logged in)
 * 2) Under User profile section: check Display newcomer homepage, Default to newcomer homepage from username link and Enable the editor help panel

Alternatively, run the following in the browser console:

Mentor dashboard
To enable the mentor dashboard follow the next steps:


 * 1) Log in as an admin
 * 2) Go to Special:EditGrowthConfig and set "" and "" to zeros. This will allow anyone to enroll as a mentor.
 * 3) Go to Special:EnrollAsMentor and submit the form. This will enroll your account as a mentor.
 * 4) Mentor dashboard should be available at http://localhost:8080/wiki/Special:MentorDashboard
 * 5) Optional (if you want Mentee overview to display some data): Claim some accounts as your mentees and make some edits with them (note those accounts must have Growth features enabled, see ). After that, run the   script.

Suggested Edits
There are three basic approaches for setting up suggested edits, the main functionality of GrowthExperiments, in a developer setup:


 * 1) Have the extension use the search API of a remote (production) wiki. You won't have to deal with setting up search locally, and you will get a wide range of realistic task suggestions, but the articles suggested for those tasks won't exist on your wiki so most editing-related functionality won't work. This is the easiest way to get the homepage and guidance working in general, and to QA task suggestions. It doesn't work for structured link recommendations though since those aren't enabled on any production wiki yet.
 * 2) Set up search locally, copy-paste or import a couple articles from some real wiki. This is quite a bit more effort but doable (on Vagrant it should mostly work out of the box). It's good for backend development, probably not really worth the effort for frontend development.
 * 3) Mock all the backend logic involved with static PHP code. This is nice for frontend work as you get direct and full control over the responses from the backend.

Set up search locally
In Vagrant search can be set up with  (but it will be set up automatically as a dependency if you provision the   role). For Docker, see MediaWiki-Docker/Configuration recipes/ElasticSearch. For other setups, a basic configuration is:

See the setup notes of Extension:CirrusSearch for more details.

You can use the CirrusSearch maintenance script  for setting the ORES topics of wiki pages.

To use settings from cswiki:


 * 1) Follow the ElasticSearch instructions from 1>Special:MyLanguage/MediaWiki-Docker/Configuration_recipes/ElasticSearch|MediaWiki-Docker/Configuration_recipes/ElasticSearch.


 * 1) Copy the contents of MediaWiki:NewcomerTopicsOres.json to http://localhost:8080/w/index.php?title=MediaWiki:NewcomerTopicsOres.json&action=edit.  (must be signed in as an admin on MediaWiki)


 * 1) Copy the contents of MediaWiki:NewcomerTasks.json to http://localhost:8080/w/index.php?title=MediaWiki:NewcomerTasks.json&action=edit.  (must be signed in as an admin on MediaWiki)


 * 1) Add   to  .


 * 1) Add   to  </>.


 * 1) Add <tvar|1> </> to <tvar|2> .</>

To use settings from other wikis, replace "cs" with the language code of the desired wiki (for  and  ).

Link recommendations
Your local development environment can query the "external traffic" production release of the link recommendation service. Access is proxied via the api-gateway (api.wikimedia.org) which requires an access token to utilize the API. That means you need to generate a personal access token (https://api.wikimedia.org/wiki/Documentation/Getting_started/Authentication#Personal_API_tokens), when you will use the access token as the value for GELinkRecommendationServiceAccessToken in LocalSettings.php:

To allow non-existent pages (red links) as suggested edits, add the following to LocalSettings.php

To update the link recommendations for each topic:

To see which articles have corresponding link recommendation tasks:


 * 1) Go to your local wiki
 * 2) Search for

API: 2022 production edition
Register an owner-only OAuth app (with default settings) at https://meta.wikimedia.org/wiki/Special:OAuthConsumerRegistration/propose/oauth2 then set the following values in LocalSettings.php: $wgGEImageRecommendationApiHandler = "actionapi"; $wgGEImageRecommendationServiceWikiIdMasquerade = "cswiki"; $wgGEImageRecommendationServiceUrl = 'https://cs.wikipedia.org/w/api.php'; $wgGEImageRecommendationServiceAccessToken = '...'; $wgGEImageRecommendationServiceUseTitles = true;

API: MVP edition
To use the old proof-of-concept image suggestions API with the Wikipedia matching the wiki's language, set

Other settings

To use Commons as a file repository (without this the image metadata won't work), set

To tag an article for image recommendation task:

To see which articles have corresponding image recommendation tasks:


 * 1) Go to your local wiki
 * 2) Search for

Seeding Articles from Czech Wikipedia
See also https://phabricator.wikimedia.org/T274198#6972115


 * 1) Make sure that http://localhost:8080/wiki/MediaWiki:NewcomerTasks.json is the same as that in Czech Wikipedia.
 * 2) Get article titles for Growth tasks from Czech Wikipedia using the special page ApiSandBox with the following parameters: This link provides an example. Then copy the response content to a local file, eg:
 * 3) Import the XML dump by running the following command inside mediawiki installation directory
 * 4) Create "Module:Wikidata" on your local site. Copy/paste the source of https://cs.wikipedia.org/wiki/Module:Wikidata and save it.
 * 5) Update secondary tables (to get accurate information on Special:RecentChanges and Special:Statistics)
 * 6) Update ElasticSearch

User impact
(this is work in progress and will change)

By default, user impact functionality is configured to use a subpage provider, ie. for every user impact data will be read from, in the format used by.

To use real data, you can do something like

Seeding ORES topics
To import ORES topics for articles imported from a production wiki (English Wikipedia in the example below), run

To set ORES topics for some article manually, use

Depending on how the wiki is configured, you might need to manually execute the jobs the above commands scheduled: