Page MenuHomePhabricator
Create Task
Maniphest T159710

Write basic documentation for WikibaseMediaInfo extension
Closed, ResolvedPublic
Actions

Description

We want to get a review of the WikibaseMediaInfo extension. For this (but obviously not only for this) we need basic documentation for it on https://www.mediawiki.org/wiki/Extension:WikibaseMediaInfo, including:

  • Copy-paste basic page structure from an existing extensions page
  • Introduction, what the extension is about
  • Installation, setup, relevant configuration to get started
  • How to create a MediaInfo page, because this is different
  • Include a screenshot
  • Possibly a FAQ section, what can go wrong
    • Introduce the concept of "virtual" entities

Also documentation in git:

  • Readme
  • Settings

Details

SubjectRepoBranchLines +/-
Small updates to README.md filemediawiki/extensions/WikibaseMediaInfomaster+6 -6
Add README filemediawiki/extensions/WikibaseMediaInfomaster+28 -0
Customize query in gerrit

Related Objects
Search...

View Standalone Graph
This task is connected to more than 200 other tasks. Only direct parents and subtasks are shown here. Use View Standalone Graph to show more of the graph.
StatusSubtypeAssignedTask
· · ·
ResolvedBawolffT159709 Security review for WikibaseMediaInfo extension
ResolvedWMDE-leszekT159710 Write basic documentation for WikibaseMediaInfo extension
ResolvedWMDE-leszekT159238 Add installation instructions for WikibaseMediaInfo
· · ·

Event Timeline

Lydia_Pintscher created this task.Mar 6 2017, 2:46 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMar 6 2017, 2:46 PM
Lydia_Pintscher added a subtask: T159238: Add installation instructions for WikibaseMediaInfo.Mar 6 2017, 2:47 PM
Aklapper added a project: Documentation.Mar 6 2017, 9:04 PM
thiemowmde updated the task description. (Show Details)Mar 7 2017, 2:54 PM
thiemowmde added subscribers: thiemowmde, WMDE-leszek, aude and 4 others.
WMDE-leszek added a project: Wikidata-Former-Sprint-Board.Mar 7 2017, 3:42 PM
WMDE-leszek moved this task from Proposed to Backlog on the Wikidata-Former-Sprint-Board board.
Ricordisamoa subscribed.Mar 8 2017, 10:58 AM
Lydia_Pintscher moved this task from incoming to in progress on the Wikidata board.Mar 23 2017, 2:35 PM
WMDE-leszek claimed this task.Apr 6 2017, 2:14 PM
WMDE-leszek moved this task from Backlog to Doing on the Wikidata-Former-Sprint-Board board.
gerritbot subscribed.Apr 10 2017, 12:57 PM

Change 347366 had a related patch set uploaded (by WMDE-leszek):
[mediawiki/extensions/WikibaseMediaInfo@master] Add README file

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

gerritbot added a project: Patch-For-Review.Apr 10 2017, 12:57 PM
WMDE-leszek mentioned this in rEWBI3753cd2daecd: Add README file.Apr 10 2017, 1:01 PM
WMDE-leszek mentioned this in rEWBI70b770ba8fc9: Add README file.Apr 11 2017, 9:50 AM
WMDE-leszek mentioned this in rEWBIc3249d4d3433: Add README file.Apr 11 2017, 11:37 AM
WMDE-leszek moved this task from Doing to Review on the Wikidata-Former-Sprint-Board board.Apr 11 2017, 11:53 AM

I've created some basic documentation, including installation and configuration notes.
The documentation has been put into README.md file (https://gerrit.wikimedia.org/r/347366), and almost identically reproduced at https://www.mediawiki.org/wiki/Extension:WikibaseMediaInfo.

README gerrit patch, and the Mediawiki page are ready to be reviewed.

Regarding few things the tickets lists, several remarks:

  • How to create a MediaInfo page, because this is different -> currently no specific section in the docs, although it is mentioned. If required, there could be covered in a more elaborate way.
  • Include a screenshot -> no screenshot of mw.org so far. I could go and make a screenshot e.g. of http://structured-commons.wmflabs.org/wiki/MediaInfo:M13. Some concerns:
    • "No label defined (M13)" is not really representative.
    • Also there would be no actual "picture" on the screenshot. It might not be something bad, just want to make it clear.
  • Possibly a FAQ section, what can go wrong -> I don't really know what to put there, so no FAQ so far.
daniel mentioned this in rEWBIdc1450298dd5: Add README file.Apr 11 2017, 6:51 PM
daniel closed subtask T159238: Add installation instructions for WikibaseMediaInfo as Resolved.Apr 11 2017, 6:53 PM
gerritbot added a comment.Apr 11 2017, 7:02 PM

Change 347366 merged by jenkins-bot:
[mediawiki/extensions/WikibaseMediaInfo@master] Add README file

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

WMDE-leszek updated the task description. (Show Details)Apr 12 2017, 8:15 AM
WMDE-leszek moved this task from Review to Backlog on the Wikidata-Former-Sprint-Board board.

So the basic documentation at mediawiki.org is there. Still no screenshot - suggestion what to include on it are welcome!
Also no FAQ section but I am not sure if there is a need to have right now.

gerritbot added a comment.Apr 12 2017, 11:46 AM

Change 347833 had a related patch set uploaded (by Thiemo Mättig (WMDE)):
[mediawiki/extensions/WikibaseMediaInfo@master] Small updates to README.md file

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

thiemowmde mentioned this in rEWBIdec8bef47cd7: Small updates to README.md file.Apr 12 2017, 11:46 AM
gerritbot added a comment.Apr 18 2017, 3:17 PM

Change 347833 merged by jenkins-bot:
[mediawiki/extensions/WikibaseMediaInfo@master] Small updates to README.md file

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

WMDE-leszek closed this task as Resolved.Apr 18 2017, 3:49 PM
WMDE-leszek updated the task description. (Show Details)
WMDE-leszek moved this task from Backlog to Done on the Wikidata-Former-Sprint-Board board.

No need for FAQ at this point has been recognized. Screen cap added. Some more polishing of installation instructions, and minor changes to other section of the page.
With all that, this task is considered done.

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