Page MenuHomePhabricator

Include documentation/test/showcase wiki pages in Vagrant roles
Closed, ResolvedPublic

Description

It would be a good habit to include in each role a dump of wikipages for

  • documentation; at a minimum a link to the mw.org docpage, plus any vagrant-specific documentation if needed.
  • test pages/showcases, i.e. predefined files for a media handler extension, a sandbox with various examples for a parser extension... (Lightbox demo is an example of a test page for MediaViewer which we replicate by hand to vagrant boxes we use and it's not super user friendly.)

Such pages should be accessible from the main page, but different roles/dumps cannot share the same page, so there should be some system to do that. Here is a simple proposal: have these pages conform to the naming convention VagrantPage[role name][*], and replace the default MediaWiki startpage with {{Special:Prefixindex/VagrantPage}} (plus some links to vagrant documentation / info on the vagrant roles add command).

Event Timeline

Tgr raised the priority of this task from to Needs Triage.
Tgr updated the task description. (Show Details)
Tgr added a project: MediaWiki-Vagrant.
Tgr added a subscriber: Tgr.

I like this idea. I wonder if vagrant roles info <role> should serve as the entry point for basic documentation, with links to mw.org or locally imported pages. We could also perhaps should this inline documentation upon enabling a role for the first time.

We could have something like vagrant roles info --enabled as well to show the docs for the current config if that was helpful.

Tgr moved this task from Untriaged to Next up on the Multimedia board.
gerritbot added a subscriber: gerritbot.

Change 189181 had a related patch set uploaded (by Gergő Tisza):
Main page for Vagrant

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

Patch-For-Review

Change 189182 had a related patch set uploaded (by Gergő Tisza):
Add test suite for Sentry role

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

Patch-For-Review

Tgr moved this task from Next up to Reviewed, needs improvements on the Multimedia board.
Tgr set Security to None.

Change 189181 merged by jenkins-bot:
Main page for Vagrant

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

Change 189182 merged by jenkins-bot:
Add test suite for Sentry role

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