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

GrowthExperiments setup

From Wikitech-static
Revision as of 04:05, 13 January 2021 by imported>Gergő Tisza
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. Verify that the translations are complete. You should also do this ahead of the other steps, so that translators have time to add any missing translations.
    • Add the new language to the requireCompleteTranslationLanguages array in Gruntfile.js in the GrowthExperiments repo (example patch)
    • Run grunt banana:translations. This will output a list of message keys for each language with missing translations.
      • Note that the list is grouped first by i18n subdirectory, then by language, so the missing messages for each language may be split across multiple lists
      • Optional messages that don't have to be translated are also listed as missing, so there are a few false positives. You can check whether a message is optional in qqq, and you can get an idea of which messages are likely to be false positives by looking at which messages are reported as missing in almost every language, and/or in languages with very few missing translations
    • It's recommended that you wait until most or all translations have been completed and have been deployed via the train
      • When you're not sure which translations caught the train, you can check by checking out the relevant wmf branch (e.g. git checkout wmf/1.36.0-wmf.22) and running grunt banana:translations
      • Backporting translation changes is possible, but is recommended against because it requires usng scap sync-world. If the number of translations that missed the train is small, consider using temporary overrides in the MediaWiki namespace instead. (If message growthexperiments-foo is missing, copy+paste its translation into the MediaWiki:Growthexperiments-foo wiki page, then set a reminder to delete that page after the translation has been deployed via the train.)
  3. Update InitialiseSettings.php in the mediawiki/operations-config repo (example patch: 634119):
    • Enable the extension 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
        • Help pages: wgGEHelpPanelLinks
          • The title field is the page title of the wiki page to link to. Interwiki prefixes and section fragments can be used here, e.g. mw:Help/VisualEditor/User_guide/pt#Editar_referências
          • The text field is the link text. The Phabricator task requesting the deployment should specify both the title and the text for each link, but it sometimes doesn't. If the text is not specified, you can usually the page title without namespace, but use your best judgement and ask the requesting community member to confirm your guesses. 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:
        • Additional 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 InitialiseSettings.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. 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.) Run mwscript extensions/WikimediaMaintenance/createExtensionTables.php --wiki=xxwiki GrowthExperiments
    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.
    3. Check that there are enough tasks, by running mwscript extensions/GrowthExperiments/maintenance/listTaskCounts.php --wiki=xxwiki. It's especially important for the copyedit and links task types to have some tasks for each topic.
      • Ideally, we would check whether there are enough tasks before deployment, but we don't have the tooling for that yet,