Skip to content

Remove trivial tooltips from the help link#10949

Merged
krisstern merged 2 commits intojenkinsci:masterfrom
uhafner:remove-help-tooltip
Aug 13, 2025
Merged

Remove trivial tooltips from the help link#10949
krisstern merged 2 commits intojenkinsci:masterfrom
uhafner:remove-help-tooltip

Conversation

@uhafner
Copy link
Member

@uhafner uhafner commented Aug 11, 2025

Before this change, the help link showed a trivial tooltip that simply repeated the name of the control. Such tooltips distract the user. Users might even not click the link anymore because they think that the tooltip already shows the actual help message.

Bildschirmfoto 2025-08-07 um 12 48 19

Testing done

Removed the test Security2779Test#noXssInHelpLinkPanel as it is superfluous now.

Proposed changelog entries

  • human-readable text

Proposed changelog category

/label skip-changelog

Proposed upgrade guidelines

N/A

Submitter checklist

  • The Jira issue, if it exists, is well-described.
  • The changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developers, depending on the change) and are in the imperative mood (see examples). Fill in the Proposed upgrade guidelines section only if there are breaking changes or changes that may require extra steps from users during upgrade.
  • There is automated testing or an explanation as to why this change has no tests.
  • New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadocs, as appropriate.
  • New deprecations are annotated with @Deprecated(since = "TODO") or @Deprecated(forRemoval = true, since = "TODO"), if applicable.
  • New or substantially changed JavaScript is not defined inline and does not call eval to ease future introduction of Content Security Policy (CSP) directives (see documentation).
  • For dependency updates, there are links to external changelogs and, if possible, full differentials.
  • For new APIs and extension points, there is a link to at least one consumer.

Desired reviewers

@timja @janfaracik @jenkinsci/sig-ux

Before the changes are marked as ready-for-merge:

Maintainer checklist

  • There are at least two (2) approvals for the pull request and no outstanding requests for change.
  • Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.
  • Changelog entries in the pull request title and/or Proposed changelog entries are accurate, human-readable, and in the imperative mood.
  • Proper changelog labels are set so that the changelog can be generated automatically.
  • If the change needs additional upgrade steps from users, the upgrade-guide-needed label is set and there is a Proposed upgrade guidelines section in the pull request title (see example).
  • If it would make sense to backport the change to LTS, a Jira issue must exist, be a Bug or Improvement, and be labeled as lts-candidate to be considered (see query).

@comment-ops-bot comment-ops-bot bot added web-ui The PR includes WebUI changes which may need special expertise skip-changelog Should not be shown in the changelog labels Aug 11, 2025
@janfaracik
Copy link
Member

Very much agree with this - I wanted to do this myself.

Thanks!

<j:when test="${attrs.url!=null}">
<j:set var="altText" value="${attrs.featureName != null ? '%Help for feature:' + ' ' + attrs.featureName : '%Help'}" />
<a href="#" class="jenkins-help-button" tooltip="${altText}" helpURL="${rootURL}${attrs.url}">
<a href="#" class="jenkins-help-button" helpURL="${rootURL}${attrs.url}">
Copy link
Member

@timja timja Aug 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like this was originally the alt text of an img instead of a tooltip so screen readers would have read it out but it wouldn't have been visible directly to users.

787186f

Changed in uhafner@742c99e

Looks like mistakenly by me as some of the help icons had meaningful text which made sense to move there but this one didn't.

Currently this is what voiceover announces on master:

Image

With this branch it just shows a ?


I think this should be set as an aria-label, (I've tested locally and it seems right):

Suggested change
<a href="#" class="jenkins-help-button" helpURL="${rootURL}${attrs.url}">
<a href="#" class="jenkins-help-button" helpURL="${rootURL}${attrs.url}" aria-label="${altText}">

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is even better. Then I can leave the variable in place and the only change is the tooltip vs. aria-label.

Before this change, the help link showed a trivial tooltip that
simply repeated the name of the control. Such tooltips distract the user.
Users might even not click the link anymore because they think that the tooltip
already shows the actual help message. Now the additional help text
is available as aria-label only.
@uhafner uhafner force-pushed the remove-help-tooltip branch from ad8b7fb to 329affd Compare August 12, 2025 08:17
Copy link
Member

@timja timja left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@uhafner uhafner marked this pull request as ready for review August 12, 2025 08:28
Copy link
Member

@janfaracik janfaracik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, tried and looks good to me.

@timja
Copy link
Member

timja commented Aug 12, 2025

/label ready-for-merge


This PR is now ready for merge, after ~24 hours, we will merge it if there's no negative feedback.

Thanks!

@comment-ops-bot comment-ops-bot bot added the ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback label Aug 12, 2025
Copy link

@A1exKH A1exKH left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@krisstern krisstern merged commit d40fef0 into jenkinsci:master Aug 13, 2025
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback skip-changelog Should not be shown in the changelog web-ui The PR includes WebUI changes which may need special expertise

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants