Problem/Motivation

After #2873576: Add description field to ParagraphType is committed, paragraphs types can have descriptions. Let's add some to our pre-existing paragraphs types in the Paragraphs Demo module.

Proposed resolution

In each of these configuration files

paragraphs.paragraphs_type.image_text.yml
paragraphs.paragraphs_type.images.yml
paragraphs.paragraphs_type.nested_paragraph.yml
paragraphs.paragraphs_type.text.yml
paragraphs.paragraphs_type.text_image.yml
paragraphs.paragraphs_type.user.yml

add the line description: {description}, where "{description}" is an appropriate description for that paragraphs type.

Remaining tasks

User interface changes

API changes

Data model changes

CommentFileSizeAuthor
#7 demoparagraphsdescription-2876597-7.patch3.2 KBaheredia
#3 demoparagraphsdescription-2876597-3.patch3.15 KBaheredia
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

VladimirMarko created an issue. See original summary.

VladimirMarko’s picture

VladimirMarko CreditAttribution: VladimirMarko commented
Title: Add descriptions to paragraphs type in Paragraphs Demo » Add descriptions to paragraphs types in Paragraphs Demo
aheredia’s picture

aheredia CreditAttribution: aheredia commented
FileSize
demoparagraphsdescription-2876597-3.patch3.15 KB

Here are the descriptions for the demo paragraphs

aheredia’s picture

aheredia CreditAttribution: aheredia commented
Status: Active » Needs review
miro_dietiker’s picture

miro_dietiker
Location Switzerland
CreditAttribution: miro_dietiker at MD Systems GmbH commented
Status: Needs review » Needs work

Interesting, compared it with Drupal Core content type descriptions, that is for instance:
description: 'Use <em>articles</em> for time-sensitive content like news, press releases or blog posts.'

We said, we want to avoid using "paragraph type" in the UI. Following core, we could repeat the type name in emphasis.
Or we could simply say "Used for.."
In any case, as uniform as possible.

I don't like long duplicated information like paragraph type or meaningless things like "Use this paragraph to", but it still needs to be a full sentence. :-)

aheredia’s picture

aheredia CreditAttribution: aheredia commented

Thanks for the suggesions.

I'll try to improve descriptions being as uniform as possible.

aheredia’s picture

aheredia CreditAttribution: aheredia commented
FileSize
demoparagraphsdescription-2876597-7.patch3.2 KB

What do you think?

aheredia’s picture

aheredia CreditAttribution: aheredia commented
Status: Needs work » Needs review

miro_dietiker’s picture

miro_dietiker
Location Switzerland
CreditAttribution: miro_dietiker at MD Systems GmbH commented
Status: Needs review » Fixed

Thx, committed. :-)

Status: Fixed » Closed (fixed)

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