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

Proposed resolution

In each of these configuration files

paragraphs.paragraphs_type.accordion.yml
paragraphs.paragraphs_type.block.yml
paragraphs.paragraphs_type.slider.yml
paragraphs.paragraphs_type.slider_infinite.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
#15 descriptionsdemo-2876602-15.patch2.5 KBaheredia
#11 descriptionsdemo-2876602-11.patch2.5 KBaheredia
#7 descriptionsdemo-2876602-7.patch2.51 KBaheredia
#5 descriptionsdemo-2876602-5.patch2.49 KBaheredia
#3 descriptionsdemo-2876602-3.patch2.46 KBaheredia

Comments

VladimirMarko created an issue. See original summary.

VladimirMarko’s picture

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

aheredia commented
StatusFileSize
new descriptionsdemo-2876602-3.patch2.46 KB

Here it is

aheredia’s picture

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

aheredia commented
StatusFileSize
new descriptionsdemo-2876602-5.patch2.49 KB

Descriptions refactored

VladimirMarko’s picture

VladimirMarko commented
Status: Needs review » Needs work

Please end all descriptions with a period, as mentioned in https://www.drupal.org/node/2876599#comment-12077969.

  1. +++ b/modules/paragraphs_collection_demo/config/install/paragraphs.paragraphs_type.accordion.yml
@@ -8,6 +8,7 @@ dependencies:
 id: accordion
 label: Accordion
+description: 'Use <em>Accordion</em> for displaying paragraphs as an accordion' ¶

    There's an extra space at the end.

    Also, maybe we should mention what an "accordion" is? 

  2. +++ b/modules/paragraphs_collection_demo/config/install/paragraphs.paragraphs_type.slider.yml
@@ -9,6 +9,7 @@ dependencies:
+description: 'Use <em>Slider</em> for displaying paragraphs as an slick slider'

    "a slick slider" 

  3. +++ b/modules/paragraphs_collection_demo/config/install/paragraphs.paragraphs_type.slider_infinite.yml
@@ -9,6 +9,7 @@ dependencies:
+description: 'Use <em>Slider Infinite</em> for displaying paragraphs as an slick infinite slider'

    As above: "a slick infinite slider"

aheredia’s picture

aheredia commented
StatusFileSize
new descriptionsdemo-2876602-7.patch2.51 KB

Ok thanks.

Sorry for the mistakes

aheredia’s picture

aheredia commented
Status: Needs work » Needs review
VladimirMarko’s picture

VladimirMarko commented
Status: Needs review » Reviewed & tested by the community

No need to apologize.

Looks great!

primsi’s picture

primsi commented
Status: Reviewed & tested by the community » Needs work 
+++ b/modules/paragraphs_collection_demo/config/install/paragraphs.paragraphs_type.block.yml
@@ -5,3 +5,4 @@ dependencies:
+description: 'Use <em>Block</em> for adding blocks as fields.'

Similar to the other issue: "to add" instead of "for adding" :)

aheredia’s picture

aheredia commented
StatusFileSize
new descriptionsdemo-2876602-11.patch2.5 KB
aheredia’s picture

aheredia commented
Status: Needs work » Needs review
VladimirMarko’s picture

VladimirMarko commented
Status: Needs review » Reviewed & tested by the community

Looks good to me.

primsi’s picture

primsi commented
Status: Reviewed & tested by the community » Needs work

image and text + image were moved to demo. Let's add the descriptions to those too.

aheredia’s picture

aheredia commented
StatusFileSize
new descriptionsdemo-2876602-15.patch2.5 KB

image and text + image descriptions are added in last commit of #2876599: Add descriptions to paragraphs types in Paragraphs Collection

aheredia’s picture

aheredia commented
Status: Needs work » Needs review
VladimirMarko’s picture

VladimirMarko commented
Status: Needs review » Needs work

The last two patches are identical.

Also, please consider using interdiffs. It makes it easier to see what has been changed.

aheredia’s picture

aheredia commented

Totally true.

As i commented the description for image and text + image in demo are added in the other patch #2876599: Add descriptions to paragraphs types in Paragraphs Collection

If you apply bloth everything would be ok.

If you thinks its better to add to this patch and remove from the other let me know I will change them.

Regards

aheredia’s picture

aheredia commented
Status: Needs work » Needs review

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

primsi commented
Status: Needs review » Fixed

Did as proposed in #18. Thx.

Status: Fixed » Closed (fixed)

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