added patternbuilder module logs

recrit · recrit · commit dec3a82ad4db · 2016-08-22T15:17:03.000-04:00
diff --git a/docs/pattern_builder_importer.md b/docs/pattern_builder_importer.md
@@ -13,7 +13,7 @@ It converts an library of JSON Schemas into Drupal paragraph bundles, and the JS
 
 1. With a library of patterns created in Pattern Builder, we need a method for creating each Drupal admin interface that allow users to enter the data needed for each template.
 
-1. As a content admin, you may want to create a customizable content type(s) which include entity references to smaller content patterns, such as field collection bundles. These bundles will be built to match the defined components from the Styleguide. This would expose the ability to both create content and control the ordering, layout, and design from within the node editing interface, and would be fully revisionable. Additionally, editors would be able reference & include existing view blocks within the field groups. Editors could then apply data attributes such as layout and theme to these view blocks or field collections.
+1. As a content admin, you may want to create a customizable content type(s) which include entity references to smaller content patterns, such as field collection bundles. These bundles will be built to match the defined components from the Style guide. This would expose the ability to both create content and control the ordering, layout, and design from within the node editing interface, and would be fully revisionable. Additionally, editors would be able reference & include existing view blocks within the field groups. Editors could then apply data attributes such as layout and theme to these view blocks or field collections.
 
 
 ### Where
@@ -48,11 +48,11 @@ It converts an library of JSON Schemas into Drupal paragraph bundles, and the JS
 
 1. Drush Commands
     1. Imports patterns from defined library
-        - drush pbi  : Import all schemas.
-        - drush pbi --all  :  Force the import of all schemas even if specific schemas are defined.
-        - drush pbi band card :  Import only the "band" and "card" schemas.
-        - drush pbi --type=layout  : Import only the schemas for the "layout" pattern type.
-        - drush pbi -image_box
+        - drush pbi : Import all schemas.
+        - drush pbi --all : Force the import of all schemas even if specific schemas are defined.
+        - drush pbi band card : Import only the "band" and "card" schemas.
+        - drush pbi --type=layout : Import only the schemas for the "layout" pattern type.
+        - drush pbi image_box
 
     1. Remove imported patterns from Drupal
         - drush pbi-remove  : Nothing is removed. This safeguards against accidental commands.
@@ -361,15 +361,15 @@ This message is logged if the referenced property's schema is not creatable and
 
 The allowed schemas references a schema that is not imported based on the pattern's status. The "inactive" status is provided by the patternbuilder module.
 
-In Drupal, this refers to the pargraphs field's allowed bundles (schemas) which must be available on the site. This is a WARNING since this only reduces the allowed bundle options and does not block the import.
+In Drupal, this refers to the paragraphs field's allowed bundles (schemas) which must be available on the site. This is a WARNING since this only reduces the allowed bundle options and does not block the import.
 
 - - -
 
 **WARNING: 'The paragraphs field @field_name references a schema that is not creatable due to the status "deprecated", schema: schema_old.json'**
 
 The allowed schemas references a schema that is not creatable based on the pattern's status. The "inactive" and "deprecated" statuses are provided by the patternbuilder module.
 
-In Drupal, this refers to the pargraphs field's allowed bundles (schemas) which must be allowed to be created on the site. This is a WARNING since this only reduces the allowed bundle options and does not block the import.
+In Drupal, this refers to the paragraphs field's allowed bundles (schemas) which must be allowed to be created on the site. This is a WARNING since this only reduces the allowed bundle options and does not block the import.
 
 - - -
 
diff --git a/docs/pattern_builder_module.md b/docs/pattern_builder_module.md
@@ -9,7 +9,7 @@ title: Pattern Builder Drupal Module
 
 The Pattern Builder Module empowers your team to prototype in a static pattern library and then import the designs and content data model into Drupal with a single drush command.
 
-Need to update your design? No problem! Just update and QA the code in your pattern library and import those changes in seconds.
+Need to update your design? No problem! Just update and QA the code in your pattern library and import those changes to Drupal in seconds.
 
 
 ### Why
@@ -27,28 +27,17 @@ Need to update your design? No problem! Just update and QA the code in your patt
 
 ### How
 
-Good question! It could be:
+The Pattern Builder module contains a composer.json to build the library dependencies.
+Below are some options to integrate the patternbuilder module into a project.
 
-1. Composer Module
-    - Add composer dependency
-    - Symlink assets to web/app root (or use custom install location)
-    - Create pb_config.yml
-        1. Includes paths to schemas/templates/data
-        2. Includes paths to js/css to add to preview
-
-1. Git clone
-    - Clone repo to root (at least at/above theme)
-    - Repo includes
-        1. Index.php (index just pulls from app folder)
-        2. pb_config.yml
-        3. App_folder
-
-1. Grunt Project
-    - Clone grunt repo. NPM install, Bower Install, Composer install
-    - Use built in yeoman to create templates/schemas
-    - Add sass and sample data to component/layout folders
-    - Run grunt commands to compile, spin up local php server, lint etc
+1. Composer Manager Module: [https://www.drupal.org/project/composer_manager](https://www.drupal.org/project/composer_manager)
+    - Install the composer_manager module.
+    - Download and install the patternbuilder module: `drush en -y patternbuilder`
+    - See the Composer Manager's documentation for more commands.
 
+1. Git clone / Drush Make file
+    - Clone repo to the site's modules directory (Example: "sites/all/modules").
+    - Run `composer install` within the patternbuilder module's directory.
 
 ### JSON Schema Support
 
@@ -57,6 +46,41 @@ Good question! It could be:
     If the schema defines a "uniqueId" property, then the property value is set to the paragraph entity's item id during the rendering process.
 
 
+### Troubleshooting
+
+All errors and warnings are logged via the Drupal watchdog() function.
+One of the following modules should be enabled on the site:
+
+- Database logging (dblog):
+    - Drupal configuration: "/admin/config/development/logging"
+    - View logs: "/admin/reports/dblog", filter by type = "patternbuilder"
+- Syslog (syslog):
+    - Drupal configuration: "/admin/config/development/logging"
+    - View logs: Logs are available in the server log files, search for logs with "patternbuilder". Actual location depends on the server's config for syslog.
+
+
+#### Log Messages
+
+**WARNING: 'Duplicate schemas found for "my_schema" at "file:///path/to/schemas-alternative/my_schema.json". The first schema registered will be used until this conflict has been resolved. Active schema: "file:///path/to/schemas/my_schema.json"'**
+
+The Pattern Builder module allows multiple schema directories to be defined at "admin/config/content/patternbuilder". This message is logged when there is a schema file with the same name in multiple directories.
+
+- Check that the schema directories are configured correctly at "admin/config/content/patternbuilder".
+- Verify the schema files in the directories.
+
+- - -
+
+**ERROR: 'An error occurred while rendering the "pbi_my_schema" paragraph item (id:1, revision:22) on node (id:234, revision:6788): Unable to find template ".twig" (looked into: /var/www/html/path/to/schemas, /var/www/html/path/to/schemas-alternative) in "my_band.twig" at line 61.**
+
+The error log "An error occurred while rendering ..." occurs during rendering of the field formatter typically on the node page.  This error is logged for any error occurring in the Pattern Library rendering of the schema and TWIG template.
+
+This is a silent error so that it does not stop the rendering of the rest of patterns and the Drupal page. The failed pattern will not be displayed on the page.
+
+A common error is displayed above. This is an error when a TWIG template includes another template without specifying a file name.
+
+- - -
+
+
 ### TODO
 
 Install Options: (NEEDS CLEANUP)
