Release status: beta
|Implementation||User interface, API|
|Description||Delivers task suggestions to new editors and shows editors how to complete those tasks|
|Author(s)||Munaf Assaf, Matthew Flaschen, Pau Giner, Kaity Hammerstein, Ori Livneh, Rob Moen, S Page, Sam Smith, Moiz Syed|
|License||GNU General Public License 2.0 or later|
Translate the GettingStarted extension if it is available at translatewiki.net
|Check usage and version matrix; code metrics|
|Open tasks · Report a bug|
The GettingStarted extension provides an onboarding process for new editors of Wikipedia.
Features[edit | edit source]
- UX/UI described in more detail at Onboarding new Wikipedians
GettingStarted provides several interfaces for suggesting introductory tasks to newly-registered editors, and it uses guided tours to show them how to complete their first edits.
If CentralAuth is installed, GettingStarted users are redirected back to their internal referrer (or the main page, if there was no referrer) post-registration. After users are sent back, they are provided with an invitation to either edit the current page or take a suggestion of something easy to edit.
Without CentralAuth, the above is the same, but the standard core interstitial page letting you change your preferences (or click a link to return) shows. The link to their internal referrer is modified to include a GettingStarted parameter (triggering the above-mentioned invitation).
Task suggestion API[edit | edit source]
Task suggestions are provided via the API. These task suggestions are optional and only appear if the wiki has appropriate task categories set. The GettingStarted API depends on lists of articles stored in Redis and populated from on-wiki categories, which can be configured. You may also exclude certain categories via wmgGettingStartedExcludedCategories in InitialiseSettings.php.
View the help documentation via /w/api.php?action=help&modules=query%20gettingstartedgetpages. The following are some examples of types of pages you call from the API:
- Get 10 random pages, related to Earth, in JSON
- Get a single random page needing copy-editing, in JSON
- Get three random pages needing copy-editing, in XML
Dependencies[edit | edit source]
Installation[edit | edit source]
- Download and place the file(s) in a directory called GettingStarted in your extensions/ folder.
- Add the following code at the bottom of your LocalSettings.php:
- Done! Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.
See also[edit | edit source]
- List of MediaWiki messages used (English Wikipedia version)
|This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page.|