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

ManageEventIndexDialog: "Indexed rooms" wording #12334

Closed
stoically opened this issue Feb 12, 2020 · 11 comments · Fixed by matrix-org/matrix-react-sdk#4084
Closed

ManageEventIndexDialog: "Indexed rooms" wording #12334

stoically opened this issue Feb 12, 2020 · 11 comments · Fixed by matrix-org/matrix-react-sdk#4084
Assignees
Labels
A-Indexing Indexing messages via Seshat T-Enhancement

Comments

@stoically
Copy link

Issue type: ui/ux suggestion

Currently the ManageEventIndexDialog says "Indexed rooms: $processing of $total", personally I find that confusing as it kinda suggests that, if no rooms are currently processed, that no rooms are indexed at all (e.g. "Indexed rooms: 0 of 10"). Maybe two lines saying something like

  • Monitoring $total rooms in total
  • Currently working in $processing rooms

communicates more clearly what actually happens.

@jryans jryans added A-Indexing Indexing messages via Seshat T-Enhancement and removed T-Defect labels Feb 12, 2020
@jryans
Copy link
Collaborator

jryans commented Feb 12, 2020

Sounds like a reasonable improvement, I agree it's confusing as written. Feel free to submit a PR if you'd like to! 😄

@poljar
Copy link
Contributor

poljar commented Feb 14, 2020

Wouldn't the second line a bit overlap with the info we have presented in the last line? We present first how many rooms are being indexed and after that which one is indexed, and if we're idle it's a bit silly.

Picture follows.

image

@poljar poljar self-assigned this Feb 14, 2020
@jryans
Copy link
Collaborator

jryans commented Feb 14, 2020

In my opinion the current "X out of Y" presentation is quite confusing, because the "good" / "idle" state will apparently say "0 out of 10 rooms", which is hard to read at a glance, because you typically expect the "idle" state would be 100% complete (10 out of 10), but that's not actually what these numbers mean.

I actually like the look from @poljar's image above, as I think it's easier to understand at a glance. @poljar, can you also capture what it looks like with some rooms actively being indexed?

@poljar
Copy link
Contributor

poljar commented Feb 14, 2020

I aggree that it's confusing, I just find it redundant to state twice that it's not doing anything.

The case where it's doing something looks good. Picture follows, now with funny cats in the background.
image

@stoically
Copy link
Author

I'd agree that merging the last two lines in this case might be better. Maybe just Downloading messages in N rooms and omitting the room name?

@stoically
Copy link
Author

Or combining it into something like Downloading messages from N rooms, currently in $room.

@nadonomy
Copy link
Contributor

nadonomy commented Mar 5, 2020

We should really be striving to exercise clarity through brevity, and this copy should be as verbose as possible. By using whole sentences instead of simply stated information declared with colons we force the eye to read the whole thing to parse rather than being able to glance.

I think the problem here is the logic rather than the copy. If instead of "Indexed rooms: $processing of $total" we displayed "Indexed rooms: $processed of $total" then the user would see that number tick up and eventually complete to e.g. 10 of 10, which solves the core issue.

@poljar
Copy link
Contributor

poljar commented Mar 5, 2020

Just to double check, we are all aware that the number of $processed rooms will not just tick up?

The number of processed rooms will start at 0, grow to the number of encrypted rooms, but at any point in time a gap in a timeline can appear. In this case the room will be crawled again (not to the start of the timeline though).

@nadonomy
Copy link
Contributor

nadonomy commented Mar 5, 2020

I think if it's always "Indexed rooms: '$processed of $total" then that's totally fine, if you see that $processed reduces to less than $total you can infer that it's processing, and see it go back up again.

@poljar
Copy link
Contributor

poljar commented Mar 6, 2020

Updated the PR. Pictures follow.

Working:
image

Idle:
image

@nadonomy
Copy link
Contributor

nadonomy commented Mar 6, 2020

@poljar much clearer, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Indexing Indexing messages via Seshat T-Enhancement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants