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 Collection module.

Proposed resolution

In each of these configuration files

paragraphs.paragraphs_type.footer.yml
paragraphs.paragraphs_type.grid.yml
paragraphs.paragraphs_type.image.yml
paragraphs.paragraphs_type.image_text.yml
paragraphs.paragraphs_type.intro.yml
paragraphs.paragraphs_type.link.yml
paragraphs.paragraphs_type.paragraphs_container.yml
paragraphs.paragraphs_type.quote.yml
paragraphs.paragraphs_type.separator.yml
paragraphs.paragraphs_type.subtitle.yml
paragraphs.paragraphs_type.text.yml
paragraphs.paragraphs_type.title.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

Comments

VladimirMarko created an issue. See original summary.

VladimirMarko’s picture

Title: Add descriptions to paragraphs type in Paragraphs Collection Demo » Add descriptions to paragraphs type in Paragraphs Collection
VladimirMarko’s picture

Title: Add descriptions to paragraphs type in Paragraphs Collection » Add descriptions to paragraphs types in Paragraphs Collection
Issue summary: View changes
aheredia’s picture

StatusFileSize
new5.52 KB

The descriptions

aheredia’s picture

Status: Active » Needs review
aheredia’s picture

StatusFileSize
new5.58 KB

Descriptions refactored.

miro_dietiker’s picture

Status: Needs review » Needs work

The sentences should always end with a "."
I fixed in paragraphs_demo on commit, but would prefer if you update the patch.

VladimirMarko’s picture

In addition to the periods:

  1. +++ b/config/install/paragraphs.paragraphs_type.subtitle.yml
    @@ -6,3 +6,5 @@ dependencies:
    +
    

    This extra line is unnecessary.

  2. +++ b/config/install/paragraphs.paragraphs_type.link.yml
    @@ -8,3 +8,4 @@ dependencies:
    +description: 'Use <em>Link</em> for adding external or internal link with a custom link text'
    

    A missing article: "an external or internal link"

aheredia’s picture

StatusFileSize
new5.59 KB

Ok thanks.

aheredia’s picture

aheredia’s picture

StatusFileSize
new5.62 KB
aheredia’s picture

Status: Needs work » Needs review
VladimirMarko’s picture

Status: Needs review » Reviewed & tested by the community
StatusFileSize
new529 bytes
new5.59 KB

Looks like you overcompensated a bit. ;)

Just re-added one newline at the end of the paragraphs.paragraphs_type.subtitle.yml file.

Thanks for your work! :)

VladimirMarko’s picture

Let's try to set the author back to "aheredia"...
EDIT: Can't do it myself, apparently.

@miro_dietiker The authorship credit goes to aheredia.

primsi’s picture

Status: Reviewed & tested by the community » Needs work
  1. +++ b/config/install/paragraphs.paragraphs_type.footer.yml
    @@ -8,3 +8,4 @@ dependencies:
    +description: 'Use <em>Footer</em> for adding a footer.'
    

    "for adding" seems like bad english. I think it's supine, so it needs to + infinitive. So in this case "to add"

  2. +++ b/config/install/paragraphs.paragraphs_type.grid.yml
    @@ -10,3 +10,4 @@ behavior_plugins:
    +description: 'Use <em>Grid</em> for adding different paragraphs in a grid layout.'
    

    I thought that we want to avoid "grid layout" naming. IMHO "layouts" it's enough.

aheredia’s picture

StatusFileSize
new5.53 KB
aheredia’s picture

Status: Needs work » Needs review

Status: Needs review » Needs work

The last submitted patch, 16: descriptions-2876599-16.patch, failed testing.

aheredia’s picture

StatusFileSize
new5.54 KB
aheredia’s picture

Status: Needs work » Needs review
VladimirMarko’s picture

Status: Needs review » Needs work
+++ b/config/install/paragraphs.paragraphs_type.text.yml
@@ -6,3 +6,4 @@ dependencies:
+description: 'Use <em>Test</em> to add a text.'

Here is a "Test" instead of "Text".

Other than that, it looks good to me. ( Again. ;) )

aheredia’s picture

StatusFileSize
new5.54 KB
new338 bytes
aheredia’s picture

Status: Needs work » Needs review
VladimirMarko’s picture

Status: Needs review » Reviewed & tested by the community

Seems good.

primsi’s picture

Status: Reviewed & tested by the community » Needs work

Will need a re-roll after we moved images related paragraph types to demo. And given #2876597: Add descriptions to paragraphs types in Paragraphs Demo was already committed, I think we can add descriptions for image and image_text - which are now in demo - in this issue.

primsi’s picture

Hm, I got confused, there is another issue for descriptions in pc demo: #2876602: Add descriptions to paragraphs types in Paragraphs Collection Demo, the one from above was for Paragraphs. Let's then just re-roll this and add missing descriptions in the other issue.

aheredia’s picture

StatusFileSize
new5.81 KB
new1.26 KB
aheredia’s picture

Status: Needs work » Needs review

  • Primsi committed 0e9f392 on 8.x-1.x authored by aheredia
    Issue #2876599 by aheredia, VladimirMarko, Primsi: Add descriptions to...
primsi’s picture

Status: Needs review » Fixed

Committed, thanks.

Status: Fixed » Closed (fixed)

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