Page MenuHomePhabricator
Create Task
Maniphest T330627

[ES-M1] Expand developer documentation in the EntitySchema Extension
Closed, ResolvedPublic3 Estimated Story Points
Actions

Description

Currently, the developer documentation in the EntitySchema extension's README.md is quite slim and does not reflect all the common development activities that are required for day to day development.

To ensure proper onboarding to the EntitySchema extension's development (which will impact analyzability) we should ensure we document both the development setup of the extension, and common day-to-day activities.

Acceptance Criteria:

  • Installation instructions are updated to reflect our current development workflows with the mwcli tool
  • Instructions for running PHP unit tests are included with example commands
  • Instructions for running PHP linting and static analysis (phan) locally are detailed with example commands
  • Instructions for running JS linting locally are detailed with example commands
  • Instructions for running Selenium tests locally are detailed with example command

Details

SubjectRepoBranchLines +/-
More consistently recommend mwcli in README instead of fresh-nodemediawiki/extensions/EntitySchemamaster+5 -5
Clarify that MediaWiki is a prerequisite in the READMEmediawiki/extensions/EntitySchemamaster+7 -0
Add section about browser tests to the READMEmediawiki/extensions/EntitySchemamaster+61 -1
Add Readme section about updating dependenciesmediawiki/extensions/EntitySchemamaster+16 -0
Add more detailed installation instructions to the READMEmediawiki/extensions/EntitySchemamaster+94 -5
Customize query in gerrit

Related Objects
Search...

Event Timeline

ItamarWMDE created this task.Feb 27 2023, 8:24 AM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptFeb 27 2023, 8:24 AM
ItamarWMDE added a parent task: T330626: [ES-M5] [EPIC] Improve EntitySchema Documentation.Feb 27 2023, 8:32 AM
ItamarWMDE added projects: Wikidata, EntitySchema, Documentation.
ItamarWMDE added a comment.Feb 28 2023, 2:32 PM

Prio Notes:

  • Impact areas: Analyzability
  • Does not affect end users / production
  • Does not affect development efforts
  • Affects onboarding efforts
  • Does not additional stakeholders
ItamarWMDE moved this task from [DOT] Epics + Stalled to [DOT] Prioritized on the wmde-wikidata-tech board.Feb 28 2023, 2:32 PM
ItamarWMDE added a project: Wikidata Dev Team.
ItamarWMDE moved this task from Incoming to [DOT] Tech Backlog on the Wikidata Dev Team board.Feb 28 2023, 2:58 PM
karapayneWMDE moved this task from [DOT] Tech Backlog to Unified DOT Backlog on the Wikidata Dev Team board.Mar 1 2023, 10:34 AM
ItamarWMDE renamed this task from Expand developer documentation in the EntitySchema Extension to [ES-M1] Expand developer documentation in the EntitySchema Extension.Mar 2 2023, 8:06 AM
noarave set the point value for this task to 3.Mar 9 2023, 10:01 AM
noarave moved this task from Unified DOT Backlog to Sprint-∞ on the Wikidata Dev Team board.
noarave edited projects, added Wikidata Dev Team (Sprint-∞); removed Wikidata Dev Team.
ItamarWMDE moved this task from [DOT] Prioritized to Ongoing on the wmde-wikidata-tech board.Mar 10 2023, 9:03 AM
ItamarWMDE moved this task from Parents/Waiting to Todo/Backlog on the Wikidata Dev Team (Sprint-∞) board.Mar 10 2023, 9:20 AM
Michael moved this task from Backlog to M1: technical preparation on the EntitySchema board.Mar 10 2023, 10:16 AM
Michael edited projects, added EntitySchema (M1: technical preparation); removed EntitySchema.
Michael subscribed.Mar 13 2023, 4:34 PM
Michael claimed this task.Mar 14 2023, 11:55 AM
Michael moved this task from Todo/Backlog to Doing on the Wikidata Dev Team (Sprint-∞) board.
Restricted Application added a project: User-Michael. · View Herald TranscriptMar 14 2023, 11:55 AM
gerritbot added a comment.Mar 14 2023, 1:30 PM

Change 898740 had a related patch set uploaded (by Michael Große; author: Michael Große):

[mediawiki/extensions/EntitySchema@master] Add more detailed installation instructions to the README

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

gerritbot added a project: Patch-For-Review.Mar 14 2023, 1:30 PM
Michael moved this task from Doing to Peer Review on the Wikidata Dev Team (Sprint-∞) board.Mar 15 2023, 5:35 PM
gerritbot added a comment.Mar 16 2023, 4:05 PM

Change 900364 had a related patch set uploaded (by Michael Große; author: Michael Große):

[mediawiki/extensions/EntitySchema@master] Add section about browser tests to the README

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

gerritbot added a comment.Mar 20 2023, 1:28 PM

Change 901207 had a related patch set uploaded (by Michael Große; author: Michael Große):

[mediawiki/extensions/EntitySchema@master] Add Readme section about updating dependencies

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

gerritbot added a comment.Mar 21 2023, 9:23 AM

Change 898740 merged by jenkins-bot:

[mediawiki/extensions/EntitySchema@master] Add more detailed installation instructions to the README

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

ReleaseTaggerBot added a project: MW-1.41-notes (1.41.0-wmf.2; 2023-03-27).Mar 21 2023, 10:00 AM
gerritbot added a comment.Mar 21 2023, 3:57 PM

Change 901207 merged by jenkins-bot:

[mediawiki/extensions/EntitySchema@master] Add Readme section about updating dependencies

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

gerritbot added a comment.Mar 23 2023, 4:13 PM

Change 900364 merged by jenkins-bot:

[mediawiki/extensions/EntitySchema@master] Add section about browser tests to the README

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

Maintenance_bot removed a project: Patch-For-Review.Mar 23 2023, 4:30 PM
noarave moved this task from Peer Review to Tech Verification on the Wikidata Dev Team (Sprint-∞) board.Mar 24 2023, 7:51 AM
ItamarWMDE added a comment.EditedMar 29 2023, 12:31 PM

I have a few notes:

Installation instructions:

  1. The docs begin by assuming the engineer reading them knows (and has) a local MediWiki instance. I'm not sure this is a safe assumption to make, and would feel the instructions are more complete if we at least link to the mwcli installation and MediaWiki setup instructions (on the Mwcli pages in mediawiki.org).
  2. As fresh node is available through mwcli: mw dev mediawiki fresh, I feel like for consistency, cohesion and simplicity, we should use the mwcli version in our instructions as well (instead of directing engineers to install another tool).
ItamarWMDE updated the task description. (Show Details)Mar 29 2023, 12:31 PM
ItamarWMDE moved this task from Tech Verification to Todo/Backlog on the Wikidata Dev Team (Sprint-∞) board.
gerritbot added a comment.Mar 30 2023, 2:47 PM

Change 904552 had a related patch set uploaded (by Michael Große; author: Michael Große):

[mediawiki/extensions/EntitySchema@master] Clarify that MediaWiki is a prerequisite in the README

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

gerritbot added a project: Patch-For-Review.Mar 30 2023, 2:47 PM
Michael moved this task from Todo/Backlog to Doing on the Wikidata Dev Team (Sprint-∞) board.Mar 30 2023, 3:01 PM
Michael moved this task from Doing to Peer Review on the Wikidata Dev Team (Sprint-∞) board.Mar 30 2023, 3:21 PM
gerritbot added a comment.Mar 30 2023, 4:31 PM

Change 904552 merged by jenkins-bot:

[mediawiki/extensions/EntitySchema@master] Clarify that MediaWiki is a prerequisite in the README

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

ReleaseTaggerBot edited projects, added MW-1.41-notes (1.41.0-wmf.3; 2023-04-03); removed MW-1.41-notes (1.41.0-wmf.2; 2023-03-27).Mar 30 2023, 5:00 PM
Maintenance_bot removed a project: Patch-For-Review.Mar 30 2023, 5:11 PM
gerritbot added a comment.Mar 31 2023, 7:38 AM

Change 904555 had a related patch set uploaded (by Michael Große; author: Michael Große):

[mediawiki/extensions/EntitySchema@master] More consistently recommend mwcli in README instead of fresh-node

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

gerritbot added a project: Patch-For-Review.Mar 31 2023, 7:38 AM
gerritbot added a comment.Mar 31 2023, 8:41 AM

Change 904555 merged by jenkins-bot:

[mediawiki/extensions/EntitySchema@master] More consistently recommend mwcli in README instead of fresh-node

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

Michael moved this task from Peer Review to Tech Verification on the Wikidata Dev Team (Sprint-∞) board.Mar 31 2023, 8:51 AM
Maintenance_bot removed a project: Patch-For-Review.Mar 31 2023, 9:10 AM
ItamarWMDE closed this task as Resolved.Apr 3 2023, 6:42 AM
ItamarWMDE updated the task description. (Show Details)
ItamarWMDE moved this task from Tech Verification to Our work done on the Wikidata Dev Team (Sprint-∞) board.

\o/ Looks great, thank you!

karapayneWMDE moved this task from Our work done to 2023 completed tasks on the Wikidata Dev Team (Sprint-∞) board.May 12 2023, 8:15 AM
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