Page MenuHomePhabricator

Add a top-level “Technical implementation” section to the Wikimedia Attribution Framework
Open, Needs TriagePublic

Description

Problem

Currently, technical information such as API/data-source guidance, referral traffic instructions, provenance-property guidance, and developer feedback paths included in the Wikimedia Attribution Framework is fragmented across individual signal pages. Signal data sources only contain immediate implementation guidance, but fail to communicate the nature and purpose of the available APIs.

Solution

Include a dedicated top-level section that provides implementation guidance that applies across multiple signals, reuse scenarios and, in the future, content types (T422919).
Recommended placement: in main navigation, after "Principles and levels".

Screenshot 2026-04-23 at 13.20.57.png (341×462 px, 34 KB)

This section would provide a clear entry point for reuser developers and centralize shared implementation guidance, including :

  • APIs and other data sources used to retrieve attribution signals
  • Technical implementation notes that apply across signals
  • High level Referral traffic / provenance guidance (more detailed guidance in a follow up task T424905)
  • A clear path for developers to provide feedback on the available data sources and the framework
Acceptance criteria
  • The Wikimedia Attribution Framework includes a section providing essential technical implementation details for reusers
Open questions
  • Confirm final section name
  • Confirm scope and the specific content to include in this section (see draft)

Event Timeline

Update:

  • The contents of section "Retrieving attribution metadata through Wikimedia APIs" in the "Technical implementation" page are almost ready
  • The new page and its draft contents were committed to a new branch in the Wikimedia-Attribution GitLab repo
  • What's missing: The "Signal support overview" section on this page revealed missing data source entries for the Enterprise, Action and MediaWiki REST APIs in some signal pages. We're working on documenting the missing information to ensure consistency across the site.
  • Regarding the "Traffic referral" section: This is WIP and under review by engineers/data scientists
  • Recent feedback made us realize that we might need to include a section with information about Wikimedia's User Agent policy and Rate limits to make these visible and accessible for reusers.