? ? Pending

User tests: Successful: Unsuccessful:

avatar brianteeman
brianteeman
5 Jun 2021

A tooltip is displayed for a missing download key that is not correct.

Testing Instructions

Install this fake "paid download" extension Null file. Thanks @nikosdion for the file.

Go to System > Update > Extensions

Observe the alert and the tooltip

image

The tooltip should not be displayed here as its the tooltip for the update sites view and the instructions will not work on this page.

This PR removes the tooltip from this page. I chose not to add a new tooltip with the correct information as it would just be a duplicate of the alert.

Update
replaced the tooltip with a direct link to the extension update site page

Update 2
On the page Extensions: Update Sites the tooltip has been converted from a bootstrap tooltip
image

avatar brianteeman brianteeman - open - 5 Jun 2021
avatar brianteeman brianteeman - change - 5 Jun 2021
Status New Pending
avatar joomla-cms-bot joomla-cms-bot - change - 5 Jun 2021
Category Administration com_installer
avatar nikosdion
nikosdion - comment - 5 Jun 2021

Or we could simply add data-bs-placement="bottom" to have the popover appear below the Badge.

The point of the popover is that newcomers to Joomla do not understand that the Download Key is required to install the update. Yeah, sure there's the warning at the top but experience says they don't ever read it. The point of the popover is that they are far more likely to move their pointer over the red text than look somewhere else on the page to understand what the heck is that message.

I also stand by my statement nearly 2 years prior that the Update Site edit page should allow developers to display a custom message (via a translation screen) to direct the user as to where their Download Key can be found. The Joomla interface, as it is implemented right now, expect the user to know things. My experience doing support with paying customers is that they do not understand the relation between purchasing something and having to not only install it but also type something somewhere for updates to work. Even more so when they've hired a site integrator to build their site and 6 to 12 months later they try to take over maintenance of the site and have no idea what is going on. Giving folks some hints about what they need to do helps A LOT. I observed an ~80% reduction in support tickets regarding download keys and failed updates when I started nagging people to enter their Download IDs and told them where to find them on my site.

avatar brianteeman
brianteeman - comment - 5 Jun 2021

Nik

read the tooltip. on this update extensions page the text is not correct. it is correct on the update sites page where it is also displayed.

It says click on the update sites title. This view does not have an update site title or anything that is clickable
image

The alert that is displayed on this page contains a link that takes you to the update sites page where the update site title exists and is clickable.

Happy to have a tooltip on this page but the text I am deleting actually creates issues instead of your intention of solving them

avatar nikosdion
nikosdion - comment - 5 Jun 2021

You make a very fair point that the tooltip content is misleading and its placement is awkward. I agree. You can have a different tooltip content there, e.g. “Updates for this extension will not work until you enter its Download Key in the Update Sites page. Please check the message above the list of updates for instructions.”

However, the tooltip and its content are implementation details which are up for discussion. Let's first focus on why a tooltip is there in the first place.

Joomla's extensions update process is idiosyncratic. It diverges from both update models users are familiar with: update in the software (everything is managed in the software being updated) and updates as part of a centralised software management facility / App Store (where the user needs to do nothing and updates appear “automatically”). It is very reasonable that the average user who's not overly familiar with Joomla's update model can't make the connection between the badge, the top of the page, the Update Sites page, the Download Key and something on my or any other 3PD's site. This makes updates look scary, opaque and burdensome. We need to hold the user's hand and walk them through the process.

Here's how I envisioned it about two years ago:

  • The badge is strategically placed in proximity to the checkbox they need to click to update the software. It also stands out.
  • They will very likely hover over the badge because it's a Red Angry Thing. The tooltip will tell them to look at the top of the page.
  • The top of the page tells them to enter the Download Key and has a link. Hopefully, they click on it.
  • They see the list of update sites which don't have a Download Key. If they're lost, they will hover over the Red Angry Thing there.
  • That tooltip tells them to click on the Update Site title and enter the Download Key.
  • (missing step) The Update Site edit page tells them where to get the Download Key from.
  • They paste the Download Key and click on Save & Close.
  • Now they can start over the update process.

This process is multistep but the steps lead from one to the next. This makes people think it's easy since, as you know, clarity is what people prefer over brevity.

I am not particularly attached to having a tooltip. If there's another way, e.g. making the Red Angry Thing a link, I actually prefer it; tooltips require interaction which poses a discoverability issue. They are also not very accessible which is another problem. The point is, how can we hold the user by the hand and help them navigate a scary and unfamiliar process? I am open to suggestions as long as it doesn't require the user to magically make a connection between two unrelated parts of the page because I know they won't and that will be a problem I will have to provide support for ?

avatar brianteeman
brianteeman - comment - 5 Jun 2021

the angry red text can easily be a link if thats what you want. I just wanted to remove the incorrect instructions in the tooltip

avatar nikosdion
nikosdion - comment - 5 Jun 2021

I'd prefer it a link, if it shows up legible. I believe the link should have the text-decoration-none class as well to prevent the entire badge from becoming underlined and hard to read. I can't remember if two years ago I didn't know about this class or if it didn't exist in BS4.

avatar brianteeman
brianteeman - comment - 5 Jun 2021

easy enough - almost done

avatar brianteeman brianteeman - change - 5 Jun 2021
Labels Added: ?
avatar brianteeman
brianteeman - comment - 5 Jun 2021

Changed to a link but need a little assistance making the link work and not give a direct access is not allowed

avatar brianteeman brianteeman - change - 5 Jun 2021
The description was changed
avatar brianteeman brianteeman - edited - 5 Jun 2021
avatar brianteeman
brianteeman - comment - 5 Jun 2021

All changes made as requested - please test

avatar Abernyte-Git Abernyte-Git - test_item - 6 Jun 2021 - Tested successfully
avatar Abernyte-Git
Abernyte-Git - comment - 6 Jun 2021

I have tested this item successfully on 8f1ecdd


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/34419.

avatar brianteeman
brianteeman - comment - 6 Jun 2021

This is ready for testing. The security comment is out of scope for this pr

avatar ChristineWk
ChristineWk - comment - 6 Jun 2021

Have the following current state (see screenshots).
Patch is enabled - Joomla 4.0.0-rc2-dev from today:

screen shot 2021-06-06 at 13 05 51

screen shot 2021-06-06 at 13 06 06

screen shot 2021-06-06 at 13 06 24


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/34419.
avatar brianteeman
brianteeman - comment - 6 Jun 2021

something not right there as you are displaying a tooltip that has been removed

avatar Quy
Quy - comment - 6 Jun 2021

Go to Update Sites to see tooltip.

avatar Abernyte-Git
Abernyte-Git - comment - 6 Jun 2021

I get the tooltip no longer showing as per expected at Update-Extension: Update but it does show at Extensions: Update Sites.


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/34419.

avatar RickR2H RickR2H - test_item - 14 Jun 2021 - Tested successfully
avatar RickR2H
RickR2H - comment - 14 Jun 2021

I have tested this item successfully on 46ae40a

Works like described!


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/34419.

avatar richard67 richard67 - test_item - 15 Jun 2021 - Tested successfully
avatar richard67
richard67 - comment - 15 Jun 2021

I have tested this item successfully on 46ae40a


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/34419.

avatar richard67 richard67 - change - 15 Jun 2021
Status Pending Ready to Commit
avatar richard67
richard67 - comment - 15 Jun 2021

RTC


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/34419.

avatar richard67
richard67 - comment - 15 Jun 2021

@joomdonation Setting RTC here because it does what it says. If you want, make a PR later with your suggested change after that one got merged.

avatar brianteeman brianteeman - change - 24 Jun 2021
Labels Added: ?
avatar brianteeman brianteeman - change - 24 Jun 2021
The description was changed
avatar brianteeman brianteeman - edited - 24 Jun 2021
avatar brianteeman
brianteeman - comment - 24 Jun 2021

Updated to convert the tooltip on the update sites page

avatar Quy Quy - change - 25 Jun 2021
Status Ready to Commit Pending
c7d6dec 25 Jun 2021 avatar brianteeman id
avatar brianteeman brianteeman - change - 25 Jun 2021
Labels Removed: ?
avatar RickR2H RickR2H - test_item - 7 Jul 2021 - Tested successfully
avatar RickR2H
RickR2H - comment - 7 Jul 2021

I have tested this item successfully on c7d6dec


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/34419.

avatar brianteeman
brianteeman - comment - 13 Jul 2021

would be great if this could get merged today before the language freeze

avatar richard67 richard67 - test_item - 9 Aug 2021 - Tested successfully
avatar richard67
richard67 - comment - 9 Aug 2021

I have tested this item successfully on c7d6dec


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/34419.

avatar richard67 richard67 - change - 9 Aug 2021
Status Pending Ready to Commit
avatar richard67
richard67 - comment - 9 Aug 2021

RTC


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/34419.

avatar richard67
richard67 - comment - 9 Aug 2021

would be great if this could get merged today before the language freeze

The PR doesn't have a language change anymore after it had been changed.

avatar Quy Quy - change - 25 Aug 2021
Status Ready to Commit Fixed in Code Base
Closed_Date 0000-00-00 00:00:00 2021-08-25 20:18:33
Closed_By Quy
Labels Added: ? ?
Removed: ?
avatar Quy Quy - close - 25 Aug 2021
avatar Quy Quy - merge - 25 Aug 2021
avatar Quy
Quy - comment - 25 Aug 2021

Thanks!

avatar brianteeman
brianteeman - comment - 25 Aug 2021

finally

Add a Comment

Login with GitHub to post a comment