Problem/Motivation

The Help text is shown on the Configuration page, but it should only be shown on the actual Help page.

Steps to reproduce

Visit the configuration page /admin/config/user-interface/admin-navigation and see the Help text from /admin/help/admin_navigation is shown at the top, pushing down the Setting options.

Proposed resolution

Remaining tasks

  • Update the code so that the Help text can be read on the Help page, but not under Settings.
  • Add a link to the Help page from the Configuration page, perhaps something like this?

    Admin Navigation config page

User interface changes

API changes

Data model changes

CommentFileSizeAuthor
#2 admin-navigation-short-help.png96.87 KBressa

Comments

ressa created an issue. See original summary.

ressa’s picture

Issue summary: View changes
StatusFileSize
new96.87 KB
nelo_drup’s picture

You are right, and it was my mistake: hook_help() was answering on the settings
route as well, so the whole About/Uses text rendered above the vertical tabs.

It now answers only on help.page.admin_navigation. The settings page carries a
single sentence with a link to the help page, close to your mockup — the link
is added only when the Help module is installed, since that is what provides
the route.

Released in 1.1.2.

ressa’s picture

Thanks for fixing this so fast and releasing it in a new release, it looks great now. If you think that my issue helped improve the module, feel free to set to Fixed and grant credit. In fact, it seems like all my issues are ready for that treatment :)

vinodhini.e’s picture

Status: Active » Reviewed & tested by the community

Hi,

Tested on Drupal 11.3.11 with Admin Navigation 1.1.1 and Help module enabled.

I was able to reproduce the issue. The help text from the module's Help page was displayed on the configuration page (/admin/config/user-interface/admin-navigation), pushing the settings form down the page.

Updated to Admin Navigation 1.1.2, cleared caches, and retested. The help text is no longer displayed on the configuration page, and a link to the Help page is shown instead. The full help text remains available on the Help page.

Issue is fixed in 1.1.2. Thanks.

ressa’s picture

Thanks @vinodhini.e, but the issue reported here is already committed and released so not really "Active", @nelo_drup just hasn't updated the Status to Fixed yet ...

Ideally, the Status for an issue is updated by the maintainer, when the problem is taken care of, so that everyone knows what needs to be done :)