You are browsing a read-only backup copy of Wikitech. The live site can be found at

GrowthExperiments setup

From Wikitech-static
Revision as of 09:15, 15 December 2020 by imported>Gergő Tisza
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This is a documentation for developers for adding Growth features to a Wikimedia wiki. For requesting these features as a community member, see mw:Growth/Communities/Get the Growth experiments on your wiki instead.

  1. Add special page aliases for the new language. (Example patch: 643084 Note: do not include namespace names.) Unlike the other changes described here, this is deployed via the train so it's worth doing ahead of the rest. This is an i18n change so if you need to backport it, you have to use scap sync-world.
  2. TODO check/backport translations
  3. Update InitialiseSettings.php in the mediawiki/operations-config repo (example patch: 634119):
    • Enable the extensions itself (wmgUseGrowthExperiments). This enables all main features; in rare cases, some might need to be disabled for the wiki (wgWelcomeSurveyEnabled, wgGEHelpPanelEnabled, wgGEHomepageEnabled).
    • Set various configuration options. (Many of these are strings in the wiki's language. Note that some text editors, especially console-based ones like vim, mess up some non-Latin scripts in all kinds of exciting ways. Copy-pasting is usually safe in any Unicode-aware editor; editing the pasted text, not necessarily so.) The commonly used ones correlate with the fields in the standard task template as follows:
      • Help panel:
        • Help desk: wgGEHelpPanelHelpDeskTitle
        • Archiving system: archived after 14 days of inactivity
        • Help pages: wgGEHelpPanelLinks
          • The text field is usually the page title without namespace, use your best judgement though. Use spaces not underscores (everywhere else it doesn't matter).
          • The id field is somewhat arbitrary (only used for analytics), you can try to follow conventions from other languages but ultimately it doesn't matter much.
        • Search on namespace: wgGEHelpPanelReadingModeNamespaces. Only set if it includes something other than the default (Wikipedia and Help).
        • Read more about editing: wgGEHelpPanelViewMoreTitle
      • Homepage:
        • Tutorial: wgGEHomepageTutorialTitle
        • Signature list: wgGEHomepageMentorsList
      • Suggested edits:
        • Extra links: wgGEHomepageSuggestedEditsIntroLinks
        • See below for task-specific settings.
  4. Add the wiki to the growthexperiments dblist by adding growthexperiments to the inheritsFrom list in wmf-config/config/{wiki id}.yaml in the mediawiki/operations-config repo and running composer buildDBLists (which updates dblists/growthexperiments.dblist). This is usually done in the same patch as the InitializeSettings.php changes - in general this is a bad idea as changes in one file might depend on the other, but specifically for GrowthExperiments the dblist does not do anything important so this is OK.
  5. Add on-wiki configuration. This is done on the `MediaWiki:NewcomerTasks.json` page (example: w:fr:MediaWiki:NewcomerTasks.json), which means your wiki account needs to be in staff, sysop or a similar user group. The contents correlate to table in the Suggested edits section of the standard task template. Use a descriptive edit summary such as Configuration for mw:Growth/Personalized first day/Newcomer homepage. See phab:XXX for more information.
  6. Check if there are enough tasks. TODO
  7. Deploy the config change in a backport window.
    1. (Placeholder for adding tables. This is not needed today, but by the time this page is next used, it probably will be.)
    2. Test by enabling User profile > Display newcomer homepage and Editing > Enable the editor help panel in Special:Preferences, visiting Special:ClaimMentor (this will validate the mentor page as a side effect), visiting Special:Homepage, and clicking on a suggested task to bring up the help panel in suggested editing mode.