From cec74bc3e611434cc6e6d00e53d166469932d419 Mon Sep 17 00:00:00 2001 From: John Kaeser Date: Fri, 2 Jun 2017 20:59:11 +0000 Subject: [PATCH] Documenting bear paragraph modules. --- docs/modules.md | 12 +++++++++++- .../bear_paragraph_banner.info.yml | 2 +- .../bear_paragraph_collection.info.yml | 2 +- .../bear_paragraph_image.info.yml | 2 +- .../bear_paragraph_text_and_image.info.yml | 2 +- .../bear_paragraph_text_area.info.yml | 2 +- .../bear_paragraph_two_column.info.yml | 2 +- 7 files changed, 17 insertions(+), 7 deletions(-) diff --git a/docs/modules.md b/docs/modules.md index e968c59..da43395 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -1,4 +1,4 @@ -#Bear Included Contributed Modules +# Bear Included Contributed Modules Bear includes helpful modules for site builders and developers with default settings that help start building Drupal sites faster. @@ -14,3 +14,13 @@ Bear includes helpful modules for site builders and developers with default sett - pathauto - simple_sitemap - token + +# Bear Custom Modules + +Bear comes packaged with some custom modules that are designed to speed up the site building process. Like the rest of Bear, you are encouraged to modify these modules as you see fit. + +## Bear Paragraphs + +[Paragraphs](https://www.drupal.org/project/paragraphs) is a powerful module that is extremely useful in component based approaches to site development. Each Bear Paragraph module includes a preconfigured paragraph bundle and can be enabled via drush (e.g. `drush en bear_paragraph_text_area`) or through the Drupal UI. + +To keep them lean and unobtrusive, these paragraph bundles come completely un-styled. Each is completely self-contained and does does not depend on any module other than Paragraphs. More information about each module can be found in the module's `.info.yml` file. diff --git a/modules/custom/bear_paragraph_banner/bear_paragraph_banner.info.yml b/modules/custom/bear_paragraph_banner/bear_paragraph_banner.info.yml index 736f62e..8b0d325 100644 --- a/modules/custom/bear_paragraph_banner/bear_paragraph_banner.info.yml +++ b/modules/custom/bear_paragraph_banner/bear_paragraph_banner.info.yml @@ -1,5 +1,5 @@ name: Bear Paragraph Banner -description: Provides a Banner paragraph type. +description: Provides a Banner paragraph bundle composed of an image, a title, and a subtitle. This module includes a custom template that structures the rendered paragraph using HTML5 `
` and `
` elements. package: Bear type: module diff --git a/modules/custom/bear_paragraph_collection/bear_paragraph_collection.info.yml b/modules/custom/bear_paragraph_collection/bear_paragraph_collection.info.yml index 4be729d..1e99303 100644 --- a/modules/custom/bear_paragraph_collection/bear_paragraph_collection.info.yml +++ b/modules/custom/bear_paragraph_collection/bear_paragraph_collection.info.yml @@ -1,5 +1,5 @@ name: Bear Paragraph Collection -description: Provides a Collection paragraph type. +description: Provides a Collection paragraph type, which acts as a container for other paragraphs. The content editor can choose to render the collection as a list or a grid with a selectable number of columns (2-8). Based on the selections, the module adds appropriate CSS classes for theming. package: Bear type: module diff --git a/modules/custom/bear_paragraph_image/bear_paragraph_image.info.yml b/modules/custom/bear_paragraph_image/bear_paragraph_image.info.yml index a583993..332fd9f 100644 --- a/modules/custom/bear_paragraph_image/bear_paragraph_image.info.yml +++ b/modules/custom/bear_paragraph_image/bear_paragraph_image.info.yml @@ -1,5 +1,5 @@ name: Bear Paragraph Image -description: Provides an Image paragraph type. +description: Provides an Image paragraph bundle with a single image field. package: Bear type: module diff --git a/modules/custom/bear_paragraph_text_and_image/bear_paragraph_text_and_image.info.yml b/modules/custom/bear_paragraph_text_and_image/bear_paragraph_text_and_image.info.yml index 9737017..76ed47a 100644 --- a/modules/custom/bear_paragraph_text_and_image/bear_paragraph_text_and_image.info.yml +++ b/modules/custom/bear_paragraph_text_and_image/bear_paragraph_text_and_image.info.yml @@ -1,5 +1,5 @@ name: Bear Paragraph Text and Image -description: Provides a Text and Image paragraph type. +description: Provides a Text and Image paragraph type. Content editors can choose whether the image appears to the right or left of the text area. A custom template provides appropriate markup and classes for theming. package: Bear type: module diff --git a/modules/custom/bear_paragraph_text_area/bear_paragraph_text_area.info.yml b/modules/custom/bear_paragraph_text_area/bear_paragraph_text_area.info.yml index 8595fd3..21793d4 100644 --- a/modules/custom/bear_paragraph_text_area/bear_paragraph_text_area.info.yml +++ b/modules/custom/bear_paragraph_text_area/bear_paragraph_text_area.info.yml @@ -1,5 +1,5 @@ name: Bear Paragraph Text Area -description: Provides a Text Area paragraph type. +description: Provides a Text Area paragraph type with a single text area field. package: Bear type: module diff --git a/modules/custom/bear_paragraph_two_column/bear_paragraph_two_column.info.yml b/modules/custom/bear_paragraph_two_column/bear_paragraph_two_column.info.yml index b0bb67d..7483b38 100644 --- a/modules/custom/bear_paragraph_two_column/bear_paragraph_two_column.info.yml +++ b/modules/custom/bear_paragraph_two_column/bear_paragraph_two_column.info.yml @@ -1,5 +1,5 @@ name: Bear Paragraph Two Column -description: Provides a two column paragraph type. +description: Provides a two column paragraph type that, by default, has two paragraph reference fields – one for the left column and one for the right column. These columns appear next to each other in the node edit form. package: Bear type: module