Page MenuHomePhabricator

Externalize WikibaseLexeme configuration documentation from WikibaseLexeme.git
Closed, ResolvedPublic3 Estimated Story Points

Description

Currently, configuration variables for the WikibaseLexeme MediaWiki extension are documented in the WikibaseLexeme code repository's main file. As these configuration settings constitute as usage instructions, this current location for them is not easily discoverable and might add unwanted redundancy to this particular context.

Therefore, and appropriate location for these instructions must be identified and these instructions should be included there instead. This new place for this documentation should preferably be in line with the way other MediaWiki extensions document their configuration variables, to increase discoverability, and ease any potential context shifts.

Acceptance Criteria:

  • New Location for configuration variables is identified.
  • Configuration was moved over to new location. New location is linked in the README
  • All configuration variables are covered by the new documentation.

Notes
Similar to https://doc.wikimedia.org/Wikibase/master/php/md_docs_topics_options.html , but Dan should be pulled into the loop about the true location for this

Event Timeline

Prio Notes:

  • Helps MediaWiki + Wikibase instance administrators discover configurations for Wikibase Lexeme → Affects end users (Wikibase Instance administrators / provisioners)
  • Helps current and new engineers with development efforts (single source of truth on extension configurations) ⇉ Affect current and new developers
  • Ensures configuration variables for wikibase instances are documented in one place → Affects process owners (Technical writers)

We talked about this in the documentation coffee time and concluded that we can add the options in the repository for now (rendered on doc.wikimedia.org), keeping @danshick-wmde in the loop (already subscribed here). So probably docs/topics/options.md just like in Wikibase.

Change 792584 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/extensions/Wikibase@master] docs: Add anchor to allowDataTransclusion setting

https://gerrit.wikimedia.org/r/792584

Change 792585 had a related patch set uploaded (by Lucas Werkmeister (WMDE); author: Lucas Werkmeister (WMDE)):

[mediawiki/extensions/WikibaseLexeme@master] Move options from README to docs/topics/options.md

https://gerrit.wikimedia.org/r/792585

Change 792584 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] docs: Add anchor to allowDataTransclusion setting

https://gerrit.wikimedia.org/r/792584

Change 792585 merged by jenkins-bot:

[mediawiki/extensions/WikibaseLexeme@master] Move options from README to docs/topics/options.md

https://gerrit.wikimedia.org/r/792585

Test / Verification Notes:

  • New Location for configuration variables is identified.
  • Configuration was moved over to new location. New location is linked in the README
  • All configuration variables are covered by the new documentation.

\o/ Great job, thank you!