Page MenuHomePhabricator

Quarry docs
Closed, ResolvedPublic

Description

This task is part of a project to improve processes and standards for Wikimedia technical documentation. For more information, visit the project page on mediawiki.org

Page

https://meta.wikimedia.org/wiki/Research:Quarry

Criteria

  • Typos: The page has been reviewed for typos.
  • Inclusive language: The page uses inclusive, non-gendered language.
  • Working examples: Commands and examples have been tested or reviewed for accuracy.
  • Links: Links on the page work.

Event Timeline

Copying in @rook's comment from T311404:

Has some old docs, for instance it has USE metawiki_p; though use no longer goes inside of a query in quarry. This ticket is to track updating that page to match present quarry.

KBach changed the task status from Open to In Progress.Aug 17 2022, 9:35 AM

Made minor changes to improve the flow of content, consistency, and clarity. Also reviewed the criteria listed in task description.

Copying in @rook's comment from T311404:

Has some old docs, for instance it has USE metawiki_p; though use no longer goes inside of a query in quarry. This ticket is to track updating that page to match present quarry.

As I understand it, this example is meant to demonstrate how to explicitly query an additional wiki (not the one specified in the box above the query) from the same section. So it's probably not outdated or incorrect.

If the results are outdated, then the best way would be to re-run the queries, right? If the owners of these queries cannot do that, perhaps we should just fork and run them ourselves? If that's what you mean, I think I could easily do that.

From the perspective of this doc, I don't think there is any harm in linking to a query with results from 2014 or 2016. These links exist mostly to demonstrate how to use show table and describe - I don't think anyone would really make use of these results. But I also don't see any harm in removing such links entirely and using code snippets on wiki only.

To me, this task is complete. @apaskulin, @Aklapper - please let me know if you have any comments. If not, I'll resolve this one in the coming weeks.

KBach reopened this task as In Progress.Sep 6 2022, 9:13 AM