Write some simple and understandable documentation about the Commons Reconciliation Service in an appropriate place.
Description
Description
Details
Details
Customize query in gerrit
Related Objects
Related Objects
- Mentioned In
- rLTCR01633886da39: Add end-user documentation to the recon service's info page
rLTCR89cc2231cd0c: Replace production URL with {{host}} variable (in two places) - Mentioned Here
- T295278: File captions can be retrieved by the data extension service of the Wikimedia Commons Reconciliation API
T296062: Fetch template parameters via the Commons recon service
Event Timeline
Comment Actions
As the Commons Reconciliation Service may also be used by tools outside OpenRefine (??) - a good place may be a separate page on Commons, e.g. https://commons.wikimedia.org/wiki/Commons:Reconciliation Service ??? (Advantage of placing documentation there: it can be "easily" translated by the Commons community)
Or should it simply be documented at https://commonsreconcile.toolforge.org/ itself?
Comment Actions
To be honest, I do not suspect a lot of uptake of this reconciliation service outside of OpenRefine itself, because the service isn't actually doing any "reconciliation" (no fuzzy-matching): we just use it as a mechanism to develop the Commons integration in OpenRefine because of the current architecture of the Wikibase integration there. So I would just document it at https://commonsreconcile.toolforge.org/ if it were just me, but of course there is no harm in doing it on wiki too.
Comment Actions
One important thing to document is the properties supported by the reconciliation service (so that people know what they can fetch).
For instance, it would be difficult for people to discover that they can fetch the wikitext. Depending on the outcome of T296062 and T295278, there could be other things to document there.
Comment Actions
I'll (finally) make a start during this month's sprint. Will also be useful for our midpoint report.
Comment Actions
Change 763946 had a related patch set uploaded (by Spinster; author: Spinster):
[labs/tools/commons-recon-service@main] Add end-user documentation to the recon service's info page
Comment Actions
Change 763950 had a related patch set uploaded (by Spinster; author: Spinster):
[labs/tools/commons-recon-service@main] Replace production URL with {{host}} variable (in two places)
Comment Actions
Change 763952 had a related patch set uploaded (by Spinster; author: Spinster):
[labs/tools/commons-recon-service@main] Correction gerrit > phabricator; various cosmetic updates
Comment Actions
Change 763946 merged by jenkins-bot:
[labs/tools/commons-recon-service@main] Add end-user documentation to the recon service's info page
Comment Actions
Change 763950 merged by jenkins-bot:
[labs/tools/commons-recon-service@main] Replace production URL with {{host}} variable (in two places)