Page MenuHomePhabricator

Lists: Auto-complete/lookahead search for adding tools
Closed, ResolvedPublic

Description

User Story

As a Toolhub user,
I want to be able to find existing tools
So that I can add them to my list

Acceptance Criteria

  • Given a tool is registered in toolhub, when I start typing the name of the tool, I expect to see a list of tools that match my search criteria
  • Given a tool does not exist in toolhub, when I start typing the name of the tool, I expect to see a message stating no tool was found

Out of scope

  • Home page search does not have to apply auto-complete. That will be covered in a separate story

Event Timeline

bd808 added a subscriber: Raymond_Ndibe.

Assigning to @Raymond_Ndibe per team discussion on 2021-11-03.

bd808 triaged this task as Medium priority.Nov 5 2021, 3:20 PM
bd808 renamed this task from Tool Search: Auto-complete to Lists: Auto-complete/lookahead search for adding tools.Nov 5 2021, 6:26 PM
bd808 changed the task status from Open to In Progress.Nov 13 2021, 12:10 AM
bd808 moved this task from Groomed/Ready to In Progress on the Toolhub board.

Change 738286 had a related patch set uploaded (by Raymond Ndibe; author: Raymond Ndibe):

[wikimedia/toolhub@main] Feature: Auto-complete/lookahead search for adding tools

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

Change 738286 merged by jenkins-bot:

[wikimedia/toolhub@main] Feature: Auto-complete/lookahead search for adding tools

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

bd808 changed the task status from In Progress to Open.Nov 19 2021, 5:36 PM

@sdkim This is ready for acceptance testing at https://toolhub-demo.wmcloud.org/

The search looks great @Raymond_Ndibe!
One question I had was what does the toolname in parentheses mean?
e.g.

image.png (190×1 px, 35 KB)

I would assume the "pills" being added would display the same title as what's shown on the home list page.

image.png (1×2 px, 189 KB)

The search looks great @Raymond_Ndibe!
One question I had was what does the toolname in parentheses mean?

The display in the select list is "tool.name (tool.title)".

e.g.

image.png (190×1 px, 35 KB)

I would assume the "pills" being added would display the same title as what's shown on the home list page.

image.png (1×2 px, 189 KB)

The literal value needed for the API POST call is the "name" value from the toolinfo record which is required to be a globally unique string. The value shown on a card view that you are referencing is the toolinfo record's "title" attribute which can be freeform text. I'm sure we can do some cosmetic work to have the data model display one thing in the UI and send another related thing to the backend if it can be shown that the toolinfo name is somehow confusing to users.

@bd808 Great idea, we can maybe do some quick usability testing with a few users? Likewise, an alternative is if we have the ability to see what strings are being searched for and whether they're more aligned to the tool name or tool title.

Thoughts?

@bd808 Great idea, we can maybe do some quick usability testing with a few users?

Go for it. The code is live on the demo server.

Likewise, an alternative is if we have the ability to see what strings are being searched for and whether they're more aligned to the tool name or tool title.

I'm not quite sure what you are suggesting here. Can you rephrase or expand your description? If you are suggesting that we refine the feature over time based on data analysis of the search input vs the document corpus that would be technically possible if we had an analyst and data collected from a production deploy. Currently we have neither of these.

Where is a good place to find volunteers to test this out?

Considering this task done and to conduct validating what tool name format users expect separately

✅ Acceptance Testing

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

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