Page MenuHomePhabricator
Create Task
Maniphest T278050

Improve ProofreadPage developer setup documentation
Open, Needs TriagePublic
Actions

Description

Currently to actually setup and run ProofreadPage for development purposes you need to write/copy over the en.wikisource.org config along with the associated dependent Modules and templates. This requires the setup of the ParserFunctions and/or Scribunto extensions which is quite finicky to setup

We should bundle a simplified version of the on-wiki config pages with the extension so that setting up the pages is much easier during development.

Things to do

Details

Related Changes in Gerrit:
SubjectAuthorRepoBranchLines +/-
docs: Add minimal development configuration XML dumpPrem2005mediawiki/extensions/ProofreadPagemaster+753 -0
Customize query in gerrit

Event Timeline

Soda created this task.Mar 21 2021, 3:12 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMar 21 2021, 3:12 PM
Sandyabhi subscribed.Mar 21 2021, 3:32 PM
Soda added a project: Wikimedia-Hackathon-2021.May 21 2021, 4:12 PM
Soda renamed this task from Provide a standard simplified verson of the Proofreadpage index template and ProofreadPage index config for easy setup during development to Improve ProofreadPage developer setup documentation.May 21 2021, 5:04 PM
Soda updated the task description. (Show Details)
Aklapper added a project: Documentation.May 24 2021, 9:43 AM
Bhsd moved this task from Backlog to Tests, tech debt & CI on the ProofreadPage board.Apr 8 2026, 1:32 PM
Prem2004 claimed this task.Sep 5 2026, 5:31 AM
Prem2004 subscribed.

Hi! I'd like to work on this task if it's still available.

I have reviewed the scope and understand that the goal is to simplify the ProofreadPage developer setup by bundling the required Wikisource configuration into the ProofreadPage repository. I plan to implement the development configuration and CLI setup, generate the bundled dev-config.xml dump, and test the setup using MediaWiki-Docker. I'll also investigate and fix any implementation issues found during testing.

Please assign the task to me if it's available. Thanks!

gerritbot added a comment.Sep 5 2026, 2:50 PM

Change #1336798 had a related patch set uploaded (by Prem2005; author: Prem2005):

[mediawiki/extensions/ProofreadPage@master] docs: Add minimal development configuration XML dump

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

gerritbot added a project: Patch-For-Review.Sep 5 2026, 2:50 PM
Tejinderk.2004 added subscribers: Suraj_Seth, Tejinderk.2004.Sun, Sep 6, 10:47 AM

Hi everyone!

As part of the Road to Wiki program India, @Suraj_Seth , @Prem2004 and I have been working together on T278050 – Improve ProofreadPage developer setup documentation.

We divided the work between us:

  • Suraj worked on researching the existing ProofreadPage setup, dependencies, and documentation.
  • Prem worked on implementing and testing the simplified dev-config.xml, including the required configuration, ParserFunctions, and DjVu setup.
  • I worked on updating the MediaWiki-Docker documentation — simplifying the setup instructions, documenting the new dev-config.xml workflow, adding DjVu configuration, testing steps, and troubleshooting guidance.

The updated documentation is here:
https://www.mediawiki.org/wiki/MediaWiki-Docker/Extension/ProofreadPage

Thanks to Suraj and Prem for the collaboration and support! Looking forward to any feedback on the documentation.

Prem2004 added a project: RoadToWiki.Tue, Sep 8, 2:37 PM
Hridyesh_Gupta moved this task from Incoming to To review on the RoadToWiki board.Thu, Sep 10, 5:16 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits