Problem/Motivation

The module description is quite short and it's unclear what the difference between the Field Layout and the Layout Builder module is.
The Field Layout module description is updated in #2999610: Update the Field Layout module description to Allows users to configure the display and form display by arranging fields in several columns.
There currently is no documentation for the module, so

Proposed resolution

Assuming that my understanding of the module functionality is correct: change the module description to a wording such as
Allows users to customize the display modes of rendered entities by placing fields and blocks in regions.

.

Remaining tasks

Change the description in the info file of the Layout Builder module.

User interface changes

This is a UI text change.

API changes

None.

Data model changes

None.

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

ifrik created an issue. See original summary.

ifrik’s picture

Status: Active » Needs review
FileSize
548 bytes

This needs a review by one of the maintainers of the Layout Builder module, to ensure that the functionality is described correctly.

AaronMcHale’s picture

Nice idea, building on your suggestion: "Allows users to customize the display of entities by placing fields and blocks in sections which can have rows and columns of differing sizes."

(I might come back and tweak the wording a little more but that's the best single sentence summary I can come up with right now)

ifrik’s picture

My impression so far is that the most important feature of this module is the possibility to add to the display of an entity blocks fields that are not part of that entity.
The display in sections/rows/columns is already available in the Field Layout module.

How about, leaving the concept of rows and columns covered by the word "Layout" in the module name and highlight the ability to add other items:

Allows users to customize the display of an entity with blocks and fields of other entities.

Of course, in the hook_help text we can then describe this in more detail.

xjm’s picture

+++ b/core/modules/layout_builder/layout_builder.info.yml
@@ -1,6 +1,6 @@
-description: 'Provides layout building utility.'
+description: 'Allows users to layout fields in regions and to add blocks into the display of rendered entities.'

Grammatically, this should be "Allows users to lay out..." (two words when it's a verb).

In "Add blocks into the display of rendered entities", the word "into" is redundant, and "display" and "rendered" are also redundant. Plus, we usually try to avoid the word "entity" in the UI.

How about something like:

Allows users to lay out fields and add blocks through the user interface.
xjm’s picture

Title: Update the Layout Builder module description » Update the Layout Builder module description and clarify how it differs from Field Layout
Priority: Normal » Major
Status: Needs review » Needs work

I think we should also adjust Field Layout's description to differentiate the unique purpose of Field Layout.

NW for this and #5.

Also this is almost docs gate for LB because the current description doesn't actually give any information beyond what the module name already tells you.

tim.plunkett’s picture

xjm’s picture

Thanks @tim.plunkett. #2999610: Update the Field Layout module description is in, so just #5 then.

xjm’s picture

Maybe:

Allows users to add blocks to content and arrange content fields from the frontend.

volkswagenchick’s picture

Issue tags: +badcamp 2018

tagging for badcamp 2018

tim.plunkett’s picture

Category: Bug report » Task
Issue tags: +Layout Builder stable blocker
mandclu’s picture

Assigned: Unassigned » mandclu
mandclu’s picture

Assigned: mandclu » Unassigned
Status: Needs work » Needs review
FileSize
534 bytes
559 bytes

Updated to use xjm's suggestion from #9. Please review.

Kristen Pol’s picture

The description is exactly what @xjm recommended in #9. I'll test this shortly.

Kristen Pol’s picture

Status: Needs review » Reviewed & tested by the community
FileSize
266.11 KB

The text matches in the UI. Marking RTBC. Thanks!

xjm’s picture

Status: Reviewed & tested by the community » Needs review
Issue tags: +Needs usability review

Looks great, thanks!

This could use some usability review/+1 of the text I proposed since it hasn't explicitly had that yet. Tagging for that.

DyanneNova’s picture

Status: Needs review » Needs work

I feel like the text may imply that there is a difference in what you can do with blocks vs fields on the content. I'm also not sure if frontend is clear in this description. How about "Allows users to add and arrange blocks and content fields directly on the content."?

tim.plunkett’s picture

Status: Needs work » Needs review
Issue tags: -DrupalEurope, -badcamp 2018, -Needs usability review
FileSize
533 bytes

I agree with @DyanneNova

phenaproxima’s picture

Status: Needs review » Reviewed & tested by the community

Aw yeah, that's a lot better. In you go!

  • xjm committed 898feb6 on 8.7.x
    Issue #2999719 by mandclu, ifrik, tim.plunkett, Kristen Pol, xjm,...
xjm’s picture

Status: Reviewed & tested by the community » Fixed

Looks good to me too. Great teamwork! Committed and pushed to 8.7.x.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.

tim.plunkett’s picture

Issue tags: +Blocks-Layouts

Retroactively tagging