Page MenuHomePhabricator
Create Task
Maniphest T295702

Add Lua module and Template tool types
Closed, ResolvedPublic
Actions

Description

The toolinfo.json spec currently defines tool types of web app, desktop app, bot, gadget, user script, command line tool, coding framework, and other. In presentations and other discussions @bd808 and @Bmueller have included Lua modules and "complex templates" as additional classifications for on-wiki technical contributions that Toolhub can help track. We can make this more official and discoverable by adding types named "lua module", and "template" in the specification and Toolhub's back and frontend code.

  • Add to jsonschema/toolinfo/current.yaml schema
  • Generate 1.2.1.{json,yaml} schemas
  • Update jsonschema/toolinfo/CHANGELOG.rst
  • Add /toolinfo/1.2.0 to ignoreSchemas in .jsonschema-tools.yaml
  • Add to toolhub.apps.toolinfo.models.Tool.TOOL_TYPE_CHOICES
  • Generate database migration for new TOOL_TYPE_CHOICES values
  • Generate new python translation files for new TOOL_TYPE_CHOICES values (make messages)
  • Add "search-filter-tool-type-..." messages to vue/src/assets/locales/i18n/{en,qqq}.json
  • Add fallback icons to vue/src/components/tools/ToolImage.vue
  • Document at https://meta.wikimedia.org/wiki/Toolhub/Data_model

Details

Other Assignee
Slst2020
SubjectRepoBranchLines +/-
toolhub: Bump container version to 2021-12-23-121200-productionoperations/deployment-chartsmaster+1 -1
ui: Add lua module and template tool typeswikimedia/toolhubmain+363 -35
Customize query in gerrit

Related Objects

Event Timeline

bd808 created this task.Nov 15 2021, 4:20 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptNov 15 2021, 4:20 PM
bd808 added a subscriber: • sdkim.Nov 15 2021, 4:33 PM

@sdkim Any objections or tweaks you would like to see before marking this as groomed?

bd808 updated the task description. (Show Details)Nov 15 2021, 4:34 PM
• sdkim moved this task from Backlog to Groomed/Ready on the Toolhub board.Nov 23 2021, 5:59 PM

Looks good to me! @bd808

• sdkim triaged this task as Medium priority.Nov 23 2021, 6:26 PM
Slst2020 subscribed.Nov 25 2021, 12:34 PM
Slst2020 claimed this task.Nov 25 2021, 1:30 PM
Slst2020 updated the task description. (Show Details)Nov 25 2021, 2:15 PM
Slst2020 added a comment.Nov 25 2021, 2:51 PM

Not sure about what icons to choose for the new tool types

Slst2020 moved this task from Groomed/Ready to In Progress on the Toolhub board.Nov 26 2021, 9:45 AM
gerritbot added a comment.Nov 26 2021, 10:06 AM

Change 742108 had a related patch set uploaded (by Slavina Stefanova; author: Slavina Stefanova):

[wikimedia/toolhub@main] ui: Add lua module and template tool types

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

gerritbot added a project: Patch-For-Review.Nov 26 2021, 10:06 AM
bd808 added a comment.Nov 28 2021, 5:20 PM
In T295702#7529498, @Slst2020 wrote:

Not sure about what icons to choose for the new tool types

https://materialdesignicons.com/ is a nice tool to use to look at the various built-in icons.

Slst2020 updated the task description. (Show Details)Nov 29 2021, 9:36 AM
Slst2020 updated the task description. (Show Details)Nov 29 2021, 9:54 AM
gerritbot added a comment.Nov 30 2021, 4:38 PM

Change 742108 merged by jenkins-bot:

[wikimedia/toolhub@main] ui: Add lua module and template tool types

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

Maintenance_bot removed a project: Patch-For-Review.Nov 30 2021, 5:11 PM
bd808 moved this task from In Progress to Review on the Toolhub board.Nov 30 2021, 9:06 PM

Changes are deployed to https://toolhub-demo.wmcloud.org/ for acceptance testing. I made https://toolhub-demo.wmcloud.org/tools/mw-template-codesample as an example toolinfo record for a Template.

bd808 reassigned this task from Slst2020 to • sdkim.Nov 30 2021, 11:47 PM
bd808 updated Other Assignee, added: Slst2020.
bd808 added a project: Developer-Advocacy (Oct-Dec 2021).
• sdkim added a comment.Dec 1 2021, 6:48 PM

Referenced https://toolhub-demo.wmcloud.org/tools/wikitech-module-sal as the lua module example and have checked API for new tool types persisted

✅ Acceptance Testing

• sdkim closed this task as Resolved.Dec 1 2021, 6:54 PM
Slst2020 mentioned this in T298097: Document toolinfo schema 1.2.1.Dec 21 2021, 2:36 PM
gerritbot added a comment.Dec 21 2021, 5:19 PM

Change 749220 had a related patch set uploaded (by BryanDavis; author: Bryan Davis):

[operations/deployment-charts@master] toolhub: Bump container version to 2021-12-20-122341-production

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

gerritbot added a project: Patch-For-Review.Dec 21 2021, 5:19 PM
gerritbot added a comment.Jan 5 2022, 5:23 PM

Change 749220 merged by jenkins-bot:

[operations/deployment-charts@master] toolhub: Bump container version to 2021-12-23-121200-production

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

Maintenance_bot removed a project: Patch-For-Review.Jan 5 2022, 6:15 PM
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