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
The block content module's hook_help text needs to be reviewed, because it was written long time ago and Drupal 8 has changed quite a bit.
Compact beta eval: This is UI help text. Not frozen yet.
This is the screenshot before the patch:
And This is the after:
Comment | File | Size | Author |
---|---|---|---|
#32 | Screen Shot 2015-02-12 at 3.31.15 PM.png | 220.02 KB | tengoku |
#30 | interdiff.txt | 5.93 KB | tengoku |
#29 | issue-2349565-test-screenshot.png | 228.27 KB | jribeiro |
#25 | 2349565-block_content_help-23.patch | 5.79 KB | tengoku |
#23 | 2349565-block_content_help-23.patch | 5.73 KB | tengoku |
Comments
Comment #1
susanb CreditAttribution: susanb commentedThe following text is not clear: ( /admin/help/block_content)
**********************************************************************
I think it should be clearer that a custom block is created from a block type.
Comment #2
batigolixComment #3
batigolixComment #4
susanb CreditAttribution: susanb commentedComment #5
susanb CreditAttribution: susanb commentedThis patch changes wording to make explanation a bit clearer regarding the differences between a custom block and a block content type.
Comment #6
jhodgdonThis text looks great to me! I like the changes, and I think it's clear.
Someone should manually test both the Custom Blocks help page, and the text provided by this at the top of admin/structure/block/block-content and make sure the links work correctly.
Comment #7
jhodgdonAlso, was this issue supposed to be for the Block module or the Custom Block module or both?
Comment #8
batigolixthis was supposed for the block content module. ill adapt the summary
Comment #9
larowlanRight component
Comment #10
larowlan- $output = '<p>' . t('This page lists user-created blocks. These blocks are derived from block types. A block type can consist of different fields and display settings. From the block types tab you can manage these fields as well as create new block types.') . '</p>'; + $output = '<p>' . t('On this page you can create and view blocks of the different <a href="!types">block types</a>.',array('!types' => \Drupal::url('block_content.type_list'))) . '</p>'; return $output;
This text was added to specifically address that the types tab and the fact that blocks can have fields has lower discoverability in the ui.
Side note:Why are we doing this again, other than a name change the module hasn't changed since the help text was added.
Comment #11
jhodgdonlarowlan: This patch is mostly just making minor changes to the help... the idea is that now that features are fairly stable, it's a good time to review all the help and make sure it makes sense and is accurate.
And... I don't see why on the page that lists the individual block items you've created, we need to explain that block types can have fields? Linking to the block types page seems like the right thing to do?
Comment #12
jhodgdonSince this is now a "fix the help" issue, changing parent.
Comment #13
jhodgdonInstead of having one critical parent issue I have been asked to change the status of each child issue.
This one doesn't feel critical or major to me, so leaving as-is. Doesn't mean we shouldn't work on it though!
Comment #14
jhodgdonComing back to this patch..
I did some more rewriting. As a note, help should provide concepts and a road map to the functionality, but it should not get specific about how to use the (hopefully obvious) user interface. That is especially true for the page-level help.
Also we have to be careful about Field UI, because this is not a required module, so to make a link to its help we need to check if it's enabled.
With that in mind, here's a new patch. As every line differs from the last patch, I did not make an interdiff file.
Comment #15
alexpottFixing component
Comment #17
no_angel CreditAttribution: no_angel commentedComment #20
no_angel CreditAttribution: no_angel commentedBased on https://www.drupal.org/patch/reroll I ran git log --before="January 14, 2015" and could not find the commit for the issue.
I'm not sure if I am suppose to see it.
I re-ran the test (which passed on January 14, 2015) today and now its showing (failed). I'm just not that clear on the next step to do the re-roll?
Comment #21
no_angel CreditAttribution: no_angel commented- needs manual testing
+ needs reroll
Comment #22
no_angel CreditAttribution: no_angel commentedComment #23
tengokurerolled patch
Comment #25
tengokusorry i didn't notice that the routes.yml changed so i adjusted the patch to the new routes..
Comment #26
tengokuComment #27
jribeiro CreditAttribution: jribeiro commentedComment #28
jribeiro CreditAttribution: jribeiro commentedComment #29
jribeiro CreditAttribution: jribeiro commentedRevised and tested manually, since the automatic test passed. The change looks good!
Screenshot attached.
+1 RTBC
Comment #30
tengokuattaching missing interdiff from #25
Comment #31
jhodgdonThanks for rerolling and reviewing!
Can you confirm @jribeiro that you tested all of the links in the help and verified that they go where they should? And that you verified that the text in the help, when it refers to page names, button or link text, etc. matches what you actually see in the Drupal UI?
Also adding beta eval to issue summary.
Comment #32
tengokuComment #33
megansanicki CreditAttribution: megansanicki commentedI'm at the Bogota sprint and I will verify that the links go to the right place.
Comment #34
megansanicki CreditAttribution: megansanicki commentedI have checked all the links and they all go to the right place.
Comment #35
jhodgdonExcellent, thanks very much! Should be good to go then.
Comment #36
YesCT CreditAttribution: YesCT commentedgit diff --color-words
is helpful to review
---
I wondered why some links have page inside the html anchor tag, and some do not.
I wondered if this might effect translators.
I looked in core to see if one was THE way.
So it seems we have both. And not something to worry about in this issue.
rtbc from me too.
------
this applies. so removing the needs reroll tag.
Comment #37
webchickGreat work!
Committed and pushed to 8.0.x. Thanks!