Opened 5 months ago

Closed 5 months ago

Last modified 5 months ago

#33453 closed defect (fixed)

Relay Search does not have an icon for StaleDesc

Reported by: karsten Owned by: karsten
Priority: Medium Milestone:
Component: Metrics/Relay Search Version:
Severity: Normal Keywords: ux-team
Cc: metrics-team, antonela Actual Points: 0.1
Parent ID: Points:
Reviewer: Sponsor:

Description

There is a new flag in town, and nobody told Relay Search about it: StaleDesc!

We'll need a new icon to be added as src/main/resources/web/images/flags/staledesc.png, and we need a few new lines of code:

diff --git a/src/main/resources/web/js/rs/models/relay.js b/src/main/resources/web/js/rs/models/relay.js
index 11d98fce..60316b82 100644
--- a/src/main/resources/web/js/rs/models/relay.js
+++ b/src/main/resources/web/js/rs/models/relay.js
@@ -43,6 +43,9 @@ define([
                 if (flag == "Stable") {
                     output.push([flag, "stable", "This relay is suitable for long-lived circuits."]);
                 }
+                if (flag == "StaleDesc") {
+                    output.push([flag, "staledesc", "This relay should upload a new descriptor because the old one is too old."]);
+                }
                 if (flag == "V2Dir") {
                     output.push([flag, "v2dir", "This relay implements the v2 directory protocol or higher."]);
                 }

Where did we get the current set of icons from again?

Child Tickets

Change History (14)

comment:1 Changed 5 months ago by irl

The icons have come from a bunch of places but we have no easy reliable source we can just take icons from. Any suggestions on concepts for the icon?

comment:2 Changed 5 months ago by irl

Cc: antonela added

comment:3 Changed 5 months ago by karsten

Maybe a clock (not necessarily this one)?

comment:4 Changed 5 months ago by karsten

Cc: ux-team added
Status: newneeds_information

What's the correct magic spell to summon a UX person again?

comment:5 Changed 5 months ago by antonela

Cc: ux-team removed
Keywords: ux-team added

You spell .・゜゜・ abracadabra ・゜゜・.and the ux person appears

comment:6 Changed 5 months ago by antonela

We rely on FontAwesome for a broad set of icons https://fontawesome.com/. If you are loading the www styleguide, you can simply add the icon class (eg <i class="fas fa-clock"></i>) and it should work.

What does StaleDesc stand for?

Last edited 5 months ago by antonela (previous) (diff)

comment:7 in reply to:  6 Changed 5 months ago by karsten

Replying to antonela:

We rely on FontAwesome for a broad set of icons https://fontawesome.com/. If you are loading the www styleguide, you can simply add the icon class (eg <i class="fas fa-clock"></i>) and it should work.

What does StaleDesc stand for?

"This relay should upload a new descriptor because the old one is too old."

comment:8 Changed 5 months ago by antonela

So, should this icon make explicit that the relay needs maintenance?

The clock may work. If you want something more generic as "needs attention", maybe an exclamation triangle is the right choice.

https://fontawesome.com/icons/exclamation-triangle

comment:9 Changed 5 months ago by karsten

No, it's nothing that the operator could fix. It's an indication to the relay that it should soon upload a new descriptor to the authorities ("If any relay sees that it has the StaleDesc flag, it should upload some time in the first half of the voting interval.", proposal 293). I guess the main reason for adding an icon is that we have icons for all other relay flags, and we shouldn't hide this one just because we don't have an icon. Its main use case would be that developers check how often this flag is being assigned and to which relays.

comment:10 in reply to:  9 Changed 5 months ago by antonela

Replying to karsten:

I guess the main reason for adding an icon is that we have icons for all other relay flags, and we shouldn't hide this one just because we don't have an icon. Its main use case would be that developers check how often this flag is being assigned and to which relays.

I see. The clock seems appropriate, so. @irl is onboard?

comment:11 Changed 5 months ago by irl

I like the clock.

comment:12 Changed 5 months ago by karsten

Owner: changed from metrics-team to karsten
Status: needs_informationaccepted

Great! I'll put it in later today. Thanks, antonela and irl!

comment:13 Changed 5 months ago by karsten

Resolution: fixed
Status: acceptedclosed

Done. Merged and deployed. Closing.

comment:14 Changed 5 months ago by karsten

Actual Points: 0.1
Note: See TracTickets for help on using tickets.