Page MenuHomePhabricator

Create a user guide for how to use the 'beta' audience designation
Open, LowPublic3 Estimated Story Points

Description

Description

We are introducing the notion of audiences, starting with beta. Beta is already in use by at least one API module, with many more beta modules on the horizon. However, we do not currently have explicit instructions for how and where to use a beta module as part of the overall API lifecycle, nor how they should be technically configured.

Conditions of acceptance

  • Create a user guide for how and when to use the 'beta' audience designation
  • Outline the purpose of a beta module (see: https://www.mediawiki.org/wiki/Wikimedia_APIs/Stability_policy#Module_audiences for basic information; consult Halley with questions)
  • Outline the module configuration steps
    • Emphasize the outcomes for publishing an visibility, resulting from the audience definition
  • [Optional] Outline implications of 'toggleable' feature of audiences and how this will appear within the UI
  • Publish on mediawiki.org
    • Assume that we will continue updating this guide with information about additional audiences and how to use them, as we introduce them

Event Timeline

HCoplin-WMF set the point value for this task to 3.May 21 2026, 3:37 PM

Notes from estimation:

  • Consider making it more generally applicable for audiences -- 'internal' is coming soon!

As it turns out, "internal" made it into the initial Audience Designations release and is live on production. So the documentation can include that.

BPirkle subscribed.