Extension:GrowthExperiments/Technical documentation/Special:EditGrowthConfig

From mediawiki.org

The special page EditGrowthConfig allows privileged users to edit some of the configuration of GrowthExperiments features. The resulting configurations can be found in MediaWiki:GrowthExperimentsConfig.json and MediaWiki:NewcomerTasks.json

GrowthExperiments config

General configuration settings of the extension

{
    "GEHelpPanelAskMentor": true,
    "GEHelpPanelExcludedNamespaces": [],
    "GEHelpPanelHelpDeskPostOnTop": false,
    "GEHelpPanelHelpDeskTitle": "",
    "GEHelpPanelLinks": [
        {
            "title": "Wikipedia:Writing better articles",
            "text": "How to write a good article",
            "id": "Q10973854"
        },
        {
            "title": "Help:Introduction to editing with VisualEditor/1",
            "text": "How to edit a page",
            "id": "Q27888216"
        },
        {
            "title": "Help:Introduction to images with VisualEditor/1",
            "text": "How to add an image",
            "id": "Q27919584"
        },
        {
            "title": "Help:Introduction to referencing with VisualEditor/1",
            "text": "How to edit a citation",
            "id": "Q24238629"
        },
        {
            "title": "Wikipedia:Article wizard",
            "text": "How to create a new article",
            "id": "Q10968373"
        }
    ],
    "GEHelpPanelReadingModeNamespaces": [
        2,
        4,
        12
    ],
    "GEHelpPanelSearchNamespaces": [
        4,
        12
    ],
    "GEHelpPanelSuggestedEditsPreferredEditor": {
        "template-based": "visualeditor",
        "link-recommendation": "machineSuggestions"
    },
    "GEHelpPanelViewMoreTitle": "Help:Contents",
    "GEHomepageManualAssignmentMentorsList": "Wikipedia:Growth Team features/Mentor list/Manual",
    "GEHomepageMentorsList": "Wikipedia:Growth Team features/Mentor list",
    "GEHomepageSuggestedEditsIntroLinks": {
        "create": "Help:Creating pages",
        "image": "Help:Viewing media"
    },
    "GEInfoboxTemplates": [],
    "GEMentorshipEnabled": true
}

Newcomer tasks

Configuration settings for the different tasks types of Growth/Personalized_first_day/Newcomer_tasks feature.

{
    "copyedit": {
        "disabled": false,
        "group": "easy",
        "templates": [
            "Awkward",
            "Inappropriate person",
            "In-universe",
            "Tone",
            "Advert",
            "Peacock"
        ],
        "excludedTemplates": [],
        "excludedCategories": [],
        "type": "template-based",
        "learnmore": "Wikipedia:Basic copyediting"
    },
    "expand": {
        "disabled": false,
        "group": "hard",
        "templates": [
            "Stub",
            "Expand section"
        ],
        "excludedTemplates": [],
        "excludedCategories": [],
        "type": "template-based",
        "learnmore": "Wikipedia:Writing better articles"
    },
    "image-recommendation": {
        "disabled": false,
        "group": "medium",
        "templates": [],
        "excludedTemplates": [],
        "excludedCategories": [],
        "type": "image-recommendation",
        "learnmore": ""
    },
    "link-recommendation": {
        "disabled": false,
        "group": "easy",
        "templates": [],
        "excludedTemplates": [],
        "excludedCategories": [],
        "type": "link-recommendation",
        "learnmore": ""
    },
    "links": {
        "disabled": false,
        "group": "easy",
        "templates": [
            "Underlinked",
            "Dead end"
        ],
        "excludedTemplates": [],
        "excludedCategories": [],
        "type": "template-based",
        "learnmore": "Help:Introduction to editing with VisualEditor/3"
    },
    "references": {
        "disabled": false,
        "group": "medium",
        "templates": [
            "Unreferenced",
            "Unreferenced section"
        ],
        "excludedTemplates": [],
        "excludedCategories": [],
        "type": "template-based",
        "learnmore": "Wikipedia:Verifiability"
    },
    "update": {
        "disabled": false,
        "group": "medium",
        "templates": [
            "Update"
        ],
        "excludedTemplates": [],
        "excludedCategories": [],
        "type": "template-based",
        "learnmore": "Wikipedia:Pages needing attention"
    }
}

Configuring campaign-specific topics in the suggested edits module[edit]

Campaign-specific topics can be configured via GECampaignTopics and GECampaigns (task T301029).

GECampaignTopics maps the topic ID to the search expression for the topic.

GECampaigns maps the campaign name to the topics that should be shown for the campaign and the pattern used to match the campaign query parameter when the user creates an account from Special:CreateAccount. The pattern should be a full PHP PCRE regexp, including the delimiters and (if needed) start/end anchor (e.g. /^foo$/).

In the following examples, users in growth-glam-2022 campaign will see three additional topics in the suggested edits module: "Argentina", "Mexico" and "Chile". This config is added to MediaWiki:GrowthExperimentsConfig.json

{
    "GECampaignTopics": {
        "argentina": "growtharticletopic:argentina",
        "mexico": "growtharticletopic:mexico",
        "chile": "growtharticletopic:chile"
    },
    "GECampaigns": {
        "growth-glam-2022": {
            "topics": [
                "argentina",
                "mexico",
                "chile"
            ],
            "pattern": "/^growth-glam-2022$/"
        }
    }
}


For full documentation, see Extension:GrowthExperiments/Technical documentation/Campaigns/Creation of customized landing pages.