Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.Problem/Motivation
We have an excellent user guide, but its not necessarily easy to find.
It is available from https://www.drupal.org/documentation, but nothing in Drupal itself exposes it.
Proposed resolution
Point to the userguide on the empty frontpage.
Remaining tasks
Patch the Front Page view to add a link to the User Guide.
File: core/modules/node/config/optional/views.view.frontpage.yml
User guide: https://www.drupal.org/docs/user_guide/en/index.html
User interface changes
API changes
Data model changes
| Comment | File | Size | Author |
|---|---|---|---|
| #10 | interdiff-2907348-8-10.txt | 949 bytes | karthikkumarbodu |
| #10 | enable_new_users_to_learn_about_the_user_guide-2907348-10.patch | 1.81 KB | karthikkumarbodu |
| #8 | enable_new_users_to_learn_about_the_user_guide-2907348-8.patch | 735 bytes | karthikkumarbodu |
Comments
Comment #2
jhodgdonI think this is generally a good idea. However, at the moment the User Guide is only fully available in 2 languages, and partially translated into another 8 or so... not sure someone installing Drupal in some other language would appreciate being pointed to a User Guide that isn't available in their language?
I'll just make my endless plug that another option would be to have a good set of help topics that explained how to build a site, within Drupal. See #2592487: [meta] Help system overhaul and the proposed list of help topics for it on #2687107: Reorganize topics into sensible outline, and/or write more topics. (This is currently a sandbox module, which would need to be added as a Core module, and presumably added to the Standard install profile. The help topics are configuration items; a few have been written but not all.)
Comment #3
dawehnerThat is a good question. I would personally ask @gabor about that, but my rough ignorance response would be: People could at least use automatic translation tools from for example google to get at least some help.
Comment #4
Gábor HojtsyI think linking them to the English docs is better than not having any docs :)
Comment #5
hussainwebI really like the idea. I see how it can be confusing or even annoying to users to find a link to documentation not in their language but I think it is perfectly reasonable to still have it.
Maybe this would be out of the scope of discussion for this issue. I imagine that this would be especially useful in a dashboard with other relevant links. With other changes like #2906547: Add links to Drupal.org project pages to module listings in /admin/modules, I think the admin screens can build a stronger link to resources on d.o for content managers.
Comment #6
jhodgdonRegarding links to documentation, quite a bit of the Help (from hook_help()) in Drupal Core points people to pages on drupal.org already. So if you have the Help module enabled, you will see links to various documentation pages on drupal.org... which are in English of course, although if a particular language translation team wanted to, they could "translate" the link in some help text to point to a similar resource in their language, if it existed.
Comment #7
jhodgdonThe empty text for the front page is part of the Views config: core/modules/node/config/optional/views.view.frontpage.yml
Comment #8
karthikkumarbodu CreditAttribution: karthikkumarbodu as a volunteer and at Axelerant commentedComment #10
karthikkumarbodu CreditAttribution: karthikkumarbodu as a volunteer and at Axelerant commentedUpdated the test case with new default text on the front page.
Comment #11
dawehner@Gábor Hojtsy agreed in #4 to do so, I think it safe to say we agreed to do so.
The patch looks fine for me. I think we really don't have to care about existing sites, their users are beyond the point of having an empty front page :)
Comment #14
xjmWhat a great patch! Unfortunately we're in RC now so we can't backport a string change, but this is a small thing that will go a long way.
Committed to 8.5.x and even tagging for the release notes there. Thanks everyone!
Comment #16
xjmComment #17
cilefen CreditAttribution: cilefen at Institute for Advanced Study commented