Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Good first issue] Update message shown when a single index is selected in search comparison tool #173

Closed
noCharger opened this issue Apr 13, 2023 · 7 comments · Fixed by #270
Assignees
Labels
good first issue Good for newcomers

Comments

@noCharger
Copy link
Collaborator

What is the bug?

When the search button is pressed and a single search is performed, an error message appears saying "An index is required. Select an index."

Screen Shot 2023-04-13 at 8 31 07 AM

How can one reproduce the bug?

  1. Select index on either left or right hand side
  2. Click search button

What is the expected behavior?

Three possibilities:

  1. If a single search is not permitted, display an error message but do not execute the search.
  2. If a single search is permitted, delete the error message.
  3. If a single search is permitted, change the font color to black and display a recommendation wording such as "try comparing search results by selecting an index."

Do you have any additional context?

I would want to clarify the expected behavior.

@noCharger noCharger added bug Something isn't working untriaged labels Apr 13, 2023
@noCharger noCharger changed the title [BUG] Expect behavior of single search [BUG] Expect UX of single search Apr 13, 2023
@noCharger
Copy link
Collaborator Author

@kgcreative @lauralexis would appreciate input on this. Thanks!

@msfroh
Copy link
Collaborator

msfroh commented Apr 13, 2023

One possibility (maybe silly) would be to set the second index to match the first index by default (i.e. when you select the first index, if the second index is unset, then set the second index to match the first index). Of course, you would still need to handle the case where the user explicitly unselects an index.

IMO, the "standard" use of search comparison is running functionally "similar" queries on the same index to see what changes.

@lauralexis
Copy link

lauralexis commented Apr 13, 2023

A single search is permitted. A single search can be executed on either side (query 1 or query 2). I don't think the error message is necessarily a bug, because it explains why the search wasn't executed. We could adjust the error message for both sides for more clarity to say "An index is required to compare search results. Select an index." Let me know what you think.

@macohen
Copy link
Collaborator

macohen commented Apr 13, 2023

I'd like to keep this as simple as we can right now. I think making the messaging clearer can work just fine, but if someone is willing to pick up @msfroh's suggestion later and that works for the UX then we could do that as well.

IMO, updating the text can work to be clearer. If we go down that path, we should also label this "good first issue."

@macohen macohen removed bug Something isn't working untriaged labels Apr 13, 2023
@noCharger
Copy link
Collaborator Author

Thanks all for the great suggestions! To summarize, the next step in resolving this problem is to modify the error message. If someone wants to tweak the UX of this to auto-fill the index, please open a new issue.

@noCharger noCharger moved this from 🆕 New to Later (6 months plus) in Search Project Board Apr 13, 2023
@noCharger noCharger added the good first issue Good for newcomers label Apr 13, 2023
@noCharger noCharger changed the title [BUG] Expect UX of single search [Good first issue] Expect UX of single search Apr 13, 2023
@msfroh msfroh changed the title [Good first issue] Expect UX of single search [Good first issue] Update message shown when only a single index is selected in search comparison tool Jun 13, 2023
@msfroh msfroh changed the title [Good first issue] Update message shown when only a single index is selected in search comparison tool [Good first issue] Update message shown when a single index is selected in search comparison tool Jun 16, 2023
@evankielley
Copy link
Contributor

Will this issue be fixed by #267? If not, I can make a PR for this

@noCharger
Copy link
Collaborator Author

Will this issue be fixed by #267? If not, I can make a PR for this

Nope it's an seperate issue. Please feel free to take it!

evankielley added a commit to evankielley/dashboards-search-relevance that referenced this issue Sep 1, 2023
evankielley added a commit to evankielley/dashboards-search-relevance that referenced this issue Sep 5, 2023
noCharger pushed a commit that referenced this issue Sep 5, 2023
* Changing select index error message to be more informative (#173)

Signed-off-by: Evan Kielley <[email protected]>

* Changing select index error message to be a constant to keep code DRY (#173)

Signed-off-by: Evan Kielley <[email protected]>

* Reverting change to yarn.lock

Signed-off-by: Evan Kielley <[email protected]>

---------

Signed-off-by: Evan Kielley <[email protected]>
@github-project-automation github-project-automation bot moved this from Later (6 months plus) to ✅ Done in Search Project Board Sep 5, 2023
github-actions bot added a commit that referenced this issue Sep 5, 2023
* Changing select index error message to be more informative (#173)

Signed-off-by: Evan Kielley <[email protected]>

* Changing select index error message to be a constant to keep code DRY (#173)

Signed-off-by: Evan Kielley <[email protected]>

* Reverting change to yarn.lock

Signed-off-by: Evan Kielley <[email protected]>

---------

Signed-off-by: Evan Kielley <[email protected]>
(cherry picked from commit dff6559)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
noCharger pushed a commit that referenced this issue Sep 5, 2023
…) (#275)

* Changing select index error message to be more informative (#173)



* Changing select index error message to be a constant to keep code DRY (#173)



* Reverting change to yarn.lock



---------


(cherry picked from commit dff6559)

Signed-off-by: Evan Kielley <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
Status: Done
6 participants