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

[scanner integration] Finalize icon set for directory badges #489

Closed
eloquence opened this issue May 16, 2018 · 17 comments
Closed

[scanner integration] Finalize icon set for directory badges #489

eloquence opened this issue May 16, 2018 · 17 comments
Assignees

Comments

@eloquence
Copy link
Member

As described in this proposal and as part of epic #488, we would like to indicate landing page and source interface scan results in the directory using a few different icons that can be displayed next to an entry. In particular, we will need the following:

  • Instance is currently up
  • Instance is currently down
  • Warning (severe)
  • Warning (moderate)
  • Instance has been verified and follows best practices
  • Large icon: Instance is currently under review (for delisted entries)
@harrislapiroff
Copy link
Contributor

Here's my proposals for the three icons listed in the document:

Verified Warning (moderate) Warning (severe)
verified warning error

@eloquence should I also generate the icons for the other cases mentioned here? (up, down, under review)

@eloquence
Copy link
Member Author

LGTM! Yes please :)

@eloquence
Copy link
Member Author

Okay, with one caveat - I think the contrast between severe and moderate could be a bit greater, esp. given that people's ability to discern variations in color varies significantly.

@harrislapiroff
Copy link
Contributor

Good call, actually. I can tip up the color contrast, but maybe I'll see if I can think of any distinct shapes that might distinguish severe from moderate. Otherwise maybe moderate should actually be an icon outline instead of a solid icon.

Re: up/down - could we just have an icon to indicate if an instance is down? is it necessary to indicate both?

Gonna need to do some brainstorming on the "under review" icon...

@eloquence
Copy link
Member Author

In the interest of minimizing clutter, I'm okay with just an "instance down" indicator for now.

@harrislapiroff
Copy link
Contributor

harrislapiroff commented May 17, 2018

Actually one question that affects how I design this: how common is it for a securedrop instance to be down? Are we expecting to be showing multiples of these on a page at a time or just one, once in a while? If it's the latter, I'll do a pretty simple icon, but it will always be accompanied by text "Instance down or unreachable" or something.

@redshiftzero
Copy link
Contributor

If there is an instance with extended downtime (i.e. weeks), I think we'd want to delist them from the directory. Since there are 10 instances per page in the directory, a ballpark figure of only one instance per page being down is reasonable (ballpark upper limit figure is from Nagios which has ~8% failing checks right now, which corresponds to 1 or less instances per directory page).

tl;dr "just one, once in a while" 😇

@harrislapiroff
Copy link
Contributor

harrislapiroff commented May 17, 2018

In that case, I'd propose something like this design for that:

image

(Text is adjustable. I don't know how often Nagios scans. It could say "Instance down" or "Instance unreachable during last scan" or something.)

@eloquence
Copy link
Member Author

I like the icon! Let's kick around under what circumstances & where we want to show the icon a bit more (keeping in mind that all instances reboot every 24 hours, so will have intermittent downtime), but we can do that outside the scope of this issue.

@harrislapiroff
Copy link
Contributor

Okay, here are some new versions of these:

Verified Warning (moderate) Warning (severe) Unreachable Verification Pending
verified warning error no good pending

@eloquence
Copy link
Member Author

These look great! For the "Under Review" state, to be clear, this is for situations where an instance was previously added, but has been de-listed because it currently fails a hard check (e.g., HTTPS cert broken, mixed content warning, or instance down for an extended period of time). So what I think we need here is a large icon that can be placed on a directory entry page that would only contain text like the following:


This SecureDrop directory entry is currently under review

Freedom of the Press Foundation routinely verifies that SecureDrop instances are up and running and follow best security practices. We have detected issues with this instance, and have temporarily removed it from the directory.

(some more text including contact link)


I don't know if the "..." works for that; this icon can also be a fair bit larger than the other ones.

@harrislapiroff
Copy link
Contributor

harrislapiroff commented May 18, 2018

Oh, noted. Okay, let me give that some thought then. Maybe that should be more of a question mark icon then.

@harrislapiroff
Copy link
Contributor

Okay, here's what I think is a good final set, shown in use (these are just example designs and how these icons actually fit into the layour of a directory page is yet to be determined):

image

@eloquence
Copy link
Member Author

That looks great, @harrislapiroff. I think we'll want to use a headline like "Instance Under Review" for the question mark case (to not confuse this status with the verification process), but the icon works for me. @redshiftzero, does this icon set look good to you as well?

@redshiftzero
Copy link
Contributor

looks great! and 👍 to the "Instance Under Review" term

@harrislapiroff
Copy link
Contributor

Yeah, that makes sense. I might want to set the circle back to a hex in that case actually. I think I was maybe misunderstanding the relationship between the verification process and that review... More like

image

@eloquence
Copy link
Member Author

Oh yeah, I see what you mean. Yes, the "Verified" badge is an additional status that some (but not all) instances will earn for going the extra mile on the security measures that we recommend but do not require. At least, that's the current plan (#511), once we are done with the basic scanner integration work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants