Page MenuHomePhabricator

Tweak (interim) design of filters to clarify functionality
Closed, InvalidPublic2 Story Points

Description

Please make changes to design and on-page text in order to more prominently tell the user that she needs to fill in Participants and to clarify how filters work.

(These changes are "interim" in the sense that this entire page will be redesigned once we've added the Worklist filter, in Release II.)

OldNew

Changes to notice about fully configuring the Event

  • Make the notice more prominent by adding the following :
    • the large bold headline: Participants filter is required (in the style of h4, with color #a94442)
    • the yellow box (this is bootstrap's alert alert-warning)
    • the exclamation point icon (this is bootstrap's glyphicon glyphicon-exclamation-sign)
  • Change the wording of the notice as follows:
    • This event has not been fully configured. To generate event data, please enter Participants.

Changes to instruction text of Participants filter

Small changes will help people better understand how this works. Please change as follows (see image for design):

  • Add wiki usernames below, one per line, to limit metrics to specific participants. You can copy/paste directly from an on-wiki list. [?]

Changes to instruction text & wiki field of Categories filter

Instruction text:
Please use the following instruction text (see image for design):

  • Enter categories (with wiki names) to limit metrics to pages in those categories. [?] On Commons only, use this tool to filter files (images, videos, etc.), instead of pages.
    • [The help link will link to the help page section specified in T209121]

Wiki field

  • In cases where more than one wiki is defined for the event, please change the example text in the wiki field to say just "Wiki" (instead of en.wikipedia, as currently)
  • [In cases where only one wiki is defined, keep the current functionality, which populates the field—for real, not just as an example—with that wiki name.]

Event Timeline

jmatazzoni triaged this task as Medium priority.Nov 8 2018, 8:38 PM
jmatazzoni created this task.
jmatazzoni renamed this task from Create interim event-setup workflow and page design to account for events that have categories OR participants to Tweak Event page (interim) design to indicate that users must use either Participants or Categories filters.Nov 8 2018, 10:41 PM
jmatazzoni updated the task description. (Show Details)
jmatazzoni renamed this task from Tweak Event page (interim) design to indicate that users must use either Participants or Categories filters to Tweak (interim) Event page design to indicate that users must use either Participants or Categories filters.Nov 8 2018, 10:47 PM
Prtksxna updated the task description. (Show Details)Nov 16 2018, 4:55 AM

Added a proposed design, looking for feedback 👨🏽‍💻

Added a proposed design, looking for feedback 👨🏽‍💻

Why a border around the Almost there... box?

jmatazzoni added a comment.EditedNov 16 2018, 7:31 PM

Added a proposed design, looking for feedback 👨🏽‍💻

I think the design of this page looks good. The border Niharika asks about seems useful to me--it gives the notice a bit more prominence, which it needs. If anything, since the user will fail in her objective of setting up an event if she doesn't understand this point, I'd do more, like adding some color.... But I'm OK with this as is if you are.

Moving this to To be Estimated. (I withdrew my previous questions; I remember how this works now.)

Why a border around the Almost there... box?

Yeah, I added it to give it more prominence, especially since a lot of visual attention currently goes to the other gray boxes.

jmatazzoni set the point value for this task to 2.
jmatazzoni removed Prtksxna as the assignee of this task.Nov 27 2018, 1:18 AM
jmatazzoni updated the task description. (Show Details)
jmatazzoni renamed this task from Tweak (interim) Event page design to indicate that users must use either Participants or Categories filters to Tweak (interim) design of filters to clarify functionality.Jan 22 2019, 9:13 PM
jmatazzoni updated the task description. (Show Details)
jmatazzoni assigned this task to Prtksxna.EditedJan 22 2019, 10:39 PM

@Prtksxna, since we are no longer going to make the changes 1) to sever Categories from Participants and 2) to make Categories look at talk pages, I took the language about those out of this ticket. I was also able to update your design graphic with the right texts.

but since I'm seeing that some of this might be around a little longer than I'd thought, I also had a second look at what I call the "notice" above—the one that tells you you need to fill in Participants. I changed the language so that it's more direct: "Participants filter is required" instead of "You're almost there."

But with that change, I'm not sure the checkbox makes sense anymore. It really should be the "Notice" or the "Alert" icon, I suppose. Also, I'd like this to be the main thing that catches the user's eye when she arrives—so maybe we could add a little red/pink to whatever you do—as it had in the old version?

Please have a look. Oh, and add anything the guys need in the way of specs, so I can put this into the Ready column. Thanks.

Prtksxna updated the task description. (Show Details)Feb 11 2019, 12:17 AM
jmatazzoni removed Prtksxna as the assignee of this task.Feb 11 2019, 4:29 PM
jmatazzoni updated the task description. (Show Details)
jmatazzoni updated the task description. (Show Details)

Categories without participants (T205734) probably won't happen in the near-term, but something like the worklist filter without participants is very much feasible and more likely to happen soon-ish. In that case participants OR a worklist would be required, so ideally the messaging would allow for this. Keep in mind the messages are marked for translation, so it's best to think ahead. 11 translations exist for the current message "This event has not been completely configured. In order to generate statistics, you must add one of the following: " which is then followed by a comma-separated list of the required filters.


Change the wording of the notice as follows:

  • ... To generate metrics, ...

The message "generate statistics" is scattered around the application, hopefully it's okay to keep with this language? I may be wrong but "metric" would refer to the type or measurement, e.g. "pages created". The word "statistic" may be more exacting in this context, referring to the data gathered using each predefined metric.


please change the example text in the wiki field to "wiki name"

The current placeholder "en.wikipedia" is solely there to indicate the expected format. "wiki name" may be ambiguous, e.g. "English Wikipedia" will not work. They'll surely figure out the format (thanks to autocompletion), so maybe we could just use "wiki" instead of "wiki name"?

jmatazzoni updated the task description. (Show Details)
jmatazzoni updated the task description. (Show Details)EditedFeb 11 2019, 6:38 PM

In T209107#4944390, @MusikAnimal wrote:

Categories without participants (T205734) probably won't happen in the near-term, but something like the worklist filter without participants is very much feasible.... Keep in mind the messages are marked for translation, so it's best to think ahead. 11 translations

You'll notice this is titled the "interim" design. That is, this will be the design until we release Worklist, which will involve a complete redesign of the setup page (in Release II). Sorry that wasn't clear; I've added some language to that effect. My apologies to the translators, but interim solutions are the unavoidable cost of an Agile process.

Change the wording of the notice as follows:

  • ... To generate metrics, ...

The message "generate statistics" is scattered around the application, hopefully it's okay to keep with this language? I may be wrong but "metric" would refer to the type or measurement, e.g. "pages created". The word "statistic" may be more exacting in this context, referring to the data gathered using each predefined metric.

Thanks for pointing out that "metrics" is not used properly; I've changed the language in the Description—though not to "statistics." Statistics is a little narrow for what we're generating, which includes things like the usernames of editors and the titles of articles created. I've changed it to "event data".

please change the example text in the wiki field to "wiki name"

The current placeholder "en.wikipedia" is solely there to indicate the expected format. "wiki name" may be ambiguous, e.g. "English Wikipedia" will not work. They'll surely figure out the format (thanks to autocompletion), so maybe we could just use "wiki" instead of "wiki name"?

Hmmm. I don't think "Wiki" is any more clear than "Wiki name," which is at least parallel to "Category name." We could say: Wiki (e.g., en.wikipedia). But not all languages have an abbreviation like "e.g." and that is getting a little long anyway. As you say, there is autocomplete, so format will not really be a problem.

I don't think "Wiki" is any more clear than "Wiki name," which is at least parallel to "Category name." We could say: Wiki (e.g., en.wikipedia). But not all languages have an abbreviation like "e.g." and that is getting a little long anyway. As you say, there is autocomplete, so format will not really be a problem.

"Category name" is the name of the category, whilst the wiki is actually the domain. We already have a message "Wiki", so using it would be consistent with what we say elsewhere, e.g. settings page where you enter "wikis", at the top of Event Summary, and the column heading on the Edit List page. Sorry for the nitpick! Just trying to keep things consistent and avoid redundant messaging. For future reference, if it at all helps, you can review existing messages at https://github.com/wikimedia/eventmetrics/blob/master/i18n/en.json. We don't necessarily re-use them, but we should maybe try to if the context is the same.

I don't think "Wiki" is any more clear than "Wiki name," which is at least parallel to "Category name." We could say: Wiki (e.g., en.wikipedia). But not all languages have an abbreviation like "e.g." and that is getting a little long anyway. As you say, there is autocomplete, so format will not really be a problem.

"Category name" is the name of the category, whilst the wiki is actually the domain. We already have a message "Wiki", so using it would be consistent with what we say elsewhere, e.g. settings page where you enter "wikis", at the top of Event Summary, and the column heading on the Edit List page. Sorry for the nitpick! Just trying to keep things consistent and avoid redundant messaging. For future reference, if it at all helps, you can review existing messages at https://github.com/wikimedia/eventmetrics/blob/master/i18n/en.json. We don't necessarily re-use them, but we should maybe try to if the context is the same.

OK, changing to "Wiki."

Prtksxna updated the task description. (Show Details)Feb 12 2019, 7:34 AM
jmatazzoni closed this task as Invalid.Mar 7 2019, 11:27 PM