The access point to the online help is missing

Created on 18 December 2024, 4 months ago

Problem/Motivation

Access to Drupal's online help is currently completely missing in Drupal CMS. This is not because we no longer deliver the Help module or because the help can no longer be accessed via admin/help when the Help module is activated, but because we have forgotten that there must be a link somewhere in the design that represents the online help.

Maybe I just overlooked it, but I think that both the documentation team and the people who have written our help topics and translated them into various languages over the past few years will be very annoyed when they realize that you can now only see their work if you type the above URL directly into the address bar of your browser and press enter. That's why I would like to have the help icon back in the Drupal navigation bar.

Especially in the default configuration of Druipal CMS. This will make life much easier for users who have never worked with Drupal before.

Thank you very much.

Steps to reproduce

Spin Up Drupal CMS anyhow (DDev, sth else)
Install it as usual
Enable the Help module
Try to access the Drupal help pages without typing admin/help directly into the address bar of your browser.

Proposed resolution

Add some help Icon to the new navigation bar of drupal cms when help module is turned on.

Remaining tasks

make a patch

User interface changes

API changes

Data model changes

πŸ› Bug report
Status

Active

Component

User Interface

Created by

πŸ‡©πŸ‡ͺGermany joachim namyslo Kulmbach πŸ‡©πŸ‡ͺ πŸ‡ͺπŸ‡Ί

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @joachim namyslo
  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    @pameeela has more context, but if I remember correctly, the Help module was explicitly removed from Drupal CMS, as was the link to it in the navigation, for a good reason: the documentation provided by help is not helpfully organized -- it's segmented by module, not by task, and has no apparent consistent relationship to Drupal's actual administrative IA -- and tends to be technical in nature. In short, it just wasn't very helpful for the kind of people who would most benefit from strong documentation.

    The Documentation track is working on much better documentation, and it won't live in Drupal itself (although where it will ultimately live is unclear). Once that track's output has a permanent online home, though, I am 1000% in favor of linking to it from within Drupal's navigation!

  • πŸ‡©πŸ‡ͺGermany joachim namyslo Kulmbach πŸ‡©πŸ‡ͺ πŸ‡ͺπŸ‡Ί

    +1 for #2

    Is there any initiative for that allready, where I can learn more about this?

  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    Yes! There is a whole documentation track for Drupal CMS. It is being led by Amber Matz β†’ and eojthebrave β†’ . I would strongly suggest reaching out to them in Slack if you would like to help - I'm pretty sure they will welcome any assistance. :)

  • πŸ‡ΊπŸ‡ΈUnited States eojthebrave Minneapolis, MN

    There's an issue for the documentation track here πŸ“Œ [META] Track 3: Drupal Starshot documentation Active . And technically Lenny is the track lead, though I've been helping out with the writing work. Right now, my (and Amber's) involvement is with the adopt-a-document initiative where we've helped develop an outline for a getting started with Drupal CMS guide, and the DA has been fundraising to pay for the creation of the content which Drupalize.Me is helping to produce. So it's kind of a weird slice of documentation and honestly I'm not sure how to go about including other people in the process. Though I do think that is something that would be good to figure out.

    I know you've had experience with the Drupal User Guide, and I think this will end up being more akin to that than the wiki like documentation currently on Drupal.org. Happy to chat in Slack, feel free to ping me.

    And, to the original issue. I totally agree that once there is content written that the Drupal CMS leads are happy with we should link to it from the Drupal CMS UI. It is sorely missing at the moment.

  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    Let's postpone this until there is somewhere for a Help link to point to.

  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    Note to self: when the help (which is written!) is available online (we're waiting on the DA for that), if we can link it in the navigation, we should. This is pretty critical and I will backport it to 1.0.x.

Production build 0.71.5 2024