Page MenuHomePhabricator

Make Jenkins automatically copy documentation files to wiki pages
Open, Stalled, LowPublic

Description

Wikibase (and Wikibase extensions) maintain high- and mid-level documentation in the docs folder. To expose this documentation in a canonical location on the web, it would be useful to automatically copy the latest version of these files to mediawiki.org, when a change is merged.

The following scheme could be used:

Files from an extension's docs folder get copied to mediawiki.org as subpages of the extension's homepage. For instance, docs/options.wiki in the Wikibase repo would be copied to Extension:Wikibase/docs/master/options.wiki. To make documentation of (snapshot) releases easily accessible, the documentation should be copied (for now, manually) when a new release is made. The path for a release could looks something like Extension:Wikibase/docs/REL1_28/options.wiki.

Documentation in plain text (and in markdown?) should be wrapped in <pre> tags when copying.

Event Timeline

daniel created this task.May 31 2017, 5:10 PM
daniel updated the task description. (Show Details)
daniel added a project: User-Daniel.
Lydia_Pintscher triaged this task as Low priority.Jun 11 2017, 4:57 PM

Right now the docs folder is displayed on doc.wikimedia.org.
Probably what will happen in 2020 is we will stop trying to keep the bulk of our documentation in sync with mw.org and just link to the docs site.

Addshore changed the task status from Open to Stalled.Dec 20 2019, 9:47 AM