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.
Background: part of the task to update the hook_help texts of the Drupal 8 modules:
#1908570: [meta] Update or create hook_help() texts for D8 core modules
Tasks:
- review / write the hook_help text according to help guidelines
- check if d.o docs exist / create (placeholder) d.o. docs https://drupal.org/documentation/modules/ban
Follow up:
#2055865: Revert file permission of ban.module file from 100755 back to 100644
Comment | File | Size | Author |
---|---|---|---|
#22 | review-help-text-ban-1977644-22.patch | 908 bytes | ifrik |
#19 | review-help-text-ban-1977644-19.patch | 904 bytes | batigolix |
#16 | review-help-text-ban-1977644-16.patch | 899 bytes | batigolix |
#7 | review-help-text-ban-1977644-7.patch | 878 bytes | batigolix |
#4 | review-help-text-ban-1977644-4.patch | 1.21 KB | batigolix |
Comments
Comment #1
batigolixtagging
Comment #2
ifrikIn the current D8 dev version, a help text is displayed, but the configuration link just links to /admin/config/people - without any configuration for ban available.
Comment #3
batigolixIn my D8 version it links to http://example.com/admin/config/people/ban that leads to an actual UI
Comment #4
batigolixI added a link to the online docs
Comment #5
batigolixChanging component
Comment #6
jhodgdonLet's combine the first two sentences into a single paragraph, as in our hook_help standard.
Also, this patch should not remove the blank line here:
Other than that, and assuming someone has verified that the links work, I think it looks good!
Comment #7
batigolixI would like to keep the sentence below in its proper t function, so that it only needs to be translated once:
Comment #8
jhodgdonThat is a great idea. However, you can still make it part of the same paragraph... Ah, you did that here in your patch. Good! :)
Do you want to update the "how to create help" standards page with this formatting suggestion so people can continue to use the template there as a starting point?
Anyway, assuming this turns green, I think it's fine. I will wait to mark it "RTBC" until someone besides batigolix has verified the links work, since the first reviewer says they didn't work. Whoever is reviewing: start with a clean D8 installation and make sure the Ban module is enabled.
Comment #10
batigolix#7: review-help-text-ban-1977644-7.patch queued for re-testing.
Comment #11
batigolixI changed the standards page: https://drupal.org/node/632280
Comment #12
ifrikI've tested the patch in #7 on a clean 8.x-dev version.
Both links work and the text makes sense to me.
Comment #13
jhodgdonThanks for testing! In that case let's mark it RTBC. I think the "needs work" status change in #11 was a mistake.
Comment #14
YesCT CreditAttribution: YesCT commentedThis issue was RTBC and passing tests on July 1, the beginning of API freeze.
Comment #15
jhodgdonIn light of our discussion on other Help issues, let's fix the reference to the online documentation. I think the people working on this issue know what to do...
Comment #15.0
jhodgdonstyle
Comment #16
batigolixReverted the reference to the docs/handbook pages.
I think we prefer to refer to it as "online docs" nowadays.
Comment #17
jhodgdonI think the text inside the A tags (the link text) should be "the online documentation for the Ban module" right?
Comment #18
jhodgdonYeah, the link should be (link)online documentation for the Ban module(endlink) and the URL should also be https.
Comment #19
batigolixAttached patch:
- fixes text inside the A tags
- has https link
Comment #20
jhodgdonOK, good!
Does this need a Uses section with a link to the admin page where this banning can be done and a brief explanation of how to do it?
Comment #21
jhodgdonDoh! That Uses section is already there. :)
OK, I think this one is ready to be committed. It just adds the required link to the online docs.
Comment #22
ifrikThe link was to a handbook page that didn't exist - I've changed it to the documentation page.
Remove trailing whitespace.
Comment #23
jhodgdonDoh! Good catch. RTBC again...
Comment #24
jhodgdonThanks all! Committed to 8.x.
Comment #25
ParisLiakos CreditAttribution: ParisLiakos commentedneeds followup for this
Comment #26
jhodgdonComment #27
ifrikThis already seem to be fixed in the current 8.x version.
Comment #28
jhodgdonAgreed. I just did a git pull on 8.x and the permissions are correct for all the files in core/modules/ban.
Comment #29
vijaycs85Created follow up for #25 at #2055865: Revert file permission of ban.module file from 100755 back to 100644 and removing corresponding tag.
Comment #29.0
vijaycs85add link
Comment #30.0
(not verified) CreditAttribution: commentedUpdated issue summary with follow up #2055865