Page MenuHomePhabricator

Update and maintain CirrusSearch Documentation on mw.org
Open, MediumPublic

Description

The CirrusSearch documentation on mw.org (https://www.mediawiki.org/wiki/Extension:CirrusSearch) is out of date.
Cirrus is now tightly coupled with core and version dependencies are not obvious for third parties.
We should maybe start to version CirrusSearch properly or maybe follow core versions, e.g. CirrusSearch 1.28 requires core 1.28.
Concerning features, many new features/configs were added to cirrus but they are not mentioned in the documentation.

Event Timeline

dcausse created this task.Sep 28 2016, 9:18 AM
Restricted Application added projects: Discovery, Discovery-Search. · View Herald TranscriptSep 28 2016, 9:18 AM
Restricted Application added a subscriber: Aklapper. · View Herald Transcript
debt triaged this task as Medium priority.Sep 28 2016, 4:08 PM
debt moved this task from needs triage to Up Next on the Discovery-Search board.
debt added a subscriber: CKoerner_WMF.
debt moved this task from Up Next to later on... on the Discovery-Search board.Oct 4 2016, 5:30 PM

Since the creation of this task myself, User:Cpiral, and many others have updated the Help:CirrusSearch documentation. (totally useless diff)

While not what this task is discussing, the Help:CirrusSearch documentation does describe the features of the extension in detail. I mention this as perhaps the work required for updating Extension:CirrusSearch should focus more on the first issue in this task ("Cirrus is now tightly coupled with core and version dependencies are not obvious for third parties."), and let the latter fall to the responsibility of Help:CirrusSearch.

Reedy added a subscriber: Reedy.Jun 18 2019, 8:34 PM

We should maybe start to version CirrusSearch properly or maybe follow core versions, e.g. CirrusSearch 1.28 requires core 1.28.

T87892 helps do that with setting MW require versions, as well as better versions to the extensions itself...