MAGETWO-92021: [Tech debt] Improving dev experience for Products content-type

- Added documentation for method of storing master format as widget-directive
- Added documentation for using product conditions in a content-type

Author: shrielenee

app/code/Magento/PageBuilder/docs/CONTRIBUTING.md

@@ -25,9 +25,10 @@
 [Content type configuration]: content-type-configuration.md
 [How to add a new content type]: how-to-add-new-content-type.md
 [Events]: events.md
-[Bindings]: bindings.md
 [Master format]: master-format.md
 [Visual select]: visual-select.md
+[Reuse product conditions in content types]: product-conditions.md
+[Store component master format as widget directive]: widget-directive.md
 [Custom Toolbar]: toolbar.md
 [Roadmap and Known Issues]: roadmap.m
 

app/code/Magento/PageBuilder/docs/README.md

@@ -18,9 +18,10 @@ It replaces the default WYSIWYG Editor in the Admin area with a highly configura
     1. [Content type configuration]
     1. [How to add a new content type]
     1. [Events]
-    1. [Bindings]
     1. [Master format]
     1. [Visual select]
+    1. [Reuse product conditions in content types]
+    1. [Store component master format as widget directive]
     1. [Custom Toolbar]
 5. [Roadmap and known issues]
 
@@ -39,5 +40,7 @@ It replaces the default WYSIWYG Editor in the Admin area with a highly configura
 [Events]: events.md
 [Master format]: master-format.md
 [Visual select]: visual-select.md
+[Reuse product conditions in content types]: product-conditions.md
+[Store component master format as widget directive]: widget-directive.md
 [Custom Toolbar]: toolbar.md
 [Roadmap and Known Issues]: roadmap.md

app/code/Magento/PageBuilder/docs/architecture-overview.md

@@ -15,11 +15,11 @@
     1. [Content type configuration]
     1. [How to add a new content type]
     1. [Events]
-    1. [Bindings]
     1. [Master format]
     1. [Visual select]
+    1. [Reuse product conditions in content types]
+    1. [Store component master format as widget directive]
     1. [Custom Toolbar]
-    1. [Add image uploader to content type]
 5. [Roadmap and known issues]
 
 [Introduction]: README.md
@@ -35,11 +35,11 @@
 [Content type configuration]: content-type-configuration.md
 [How to add a new content type]: how-to-add-new-content-type.md
 [Events]: events.md
-[Bindings]: bindings.md
 [Master format]: master-format.md
 [Visual select]: visual-select.md
+[Reuse product conditions in content types]: product-conditions.md
+[Store component master format as widget directive]: widget-directive.md
 [Custom Toolbar]: toolbar.md
-[Add image uploader to content type]: image-uploader.md
 [Roadmap and Known Issues]: roadmap.md
 
 ## What is PageBuilder?
@@ -95,7 +95,7 @@ To revert back to using the default WYSIWYG, add the following entry to the fiel
 | ----------------- | --------------------- | -------------------------------------------------------------------------------------------------------------- |
 | Content type      | `component`           | View model responsible for rendering the preview and master format                                             |
 | Preview component | `preview_component`   | Contains preview specific logic that is generic for all appearances. Preview component is optional             |
-| Master component  | `master_component`    | Contains master format rendering logic that is generic for all appearances. Content component is optional      |
+| Master component  | `content_component`   | Contains master format rendering logic that is generic for all appearances. Content component is optional      |
 | Data Store        |                       | Contains data for the content type                                                                             |
 | Appearance        | `appearance`          | Configuration for content type that defines look and behavior. Includes data mapping, form, templates, reader. |
 | Preview template  | `preview_template`    | Template used to display the element in the preview                                                            |
@@ -158,7 +158,7 @@ Appearances allow you to make the following customization on existing content ty
 
 | File type                | Location                                                                                       |
 | -------------------------|------------------------------------------------------------------------------------------------|
-| Content type components  | `Vendor/ModuleName/view/adminhtml/web/js/content-type/master-type-name`                       |
+| Content type components  | `Vendor/ModuleName/view/adminhtml/web/js/content-type/content-type-name`                       |
 | Content type templates   | `Vendor/ModuleName/view/adminhtml/web/template/content-type/content-type-name/appearance-name` |
 | Styles                   | `Vendor/ModuleName/view/adminhtml/web/css/source/content-type/content-type-name`               |
 
@@ -167,4 +167,4 @@ Appearances allow you to make the following customization on existing content ty
 
 [TypeScript]: https://www.typescriptlang.org/
 [master format]: master-format.md
-[content type]: how-to-add-new-content-type.md
+[content type]: how-to-add-new-content-type.md

app/code/Magento/PageBuilder/docs/bluefoot-data-migration.md

@@ -14,11 +14,11 @@
     1. [Content type configuration]
     1. [How to add a new content type]
     1. [Events]
-    1. [Bindings]
     1. [Master format]
     1. [Visual select]
+    1. [Reuse product conditions in content types]
+    1. [Store component master format as widget directive]
     1. [Custom Toolbar]
-    1. [Add image uploader to content type]
 5. [Roadmap and known issues]
 
 [Introduction]: README.md
@@ -34,11 +34,11 @@
 [Content type configuration]: content-type-configuration.md
 [How to add a new content type]: how-to-add-new-content-type.md
 [Events]: events.md
-[Bindings]: bindings.md
 [Master format]: master-format.md
 [Visual select]: visual-select.md
+[Reuse product conditions in content types]: product-conditions.md
+[Store component master format as widget directive]: widget-directive.md
 [Custom Toolbar]: toolbar.md
-[Add image uploader to content type]: image-uploader.md
 [Roadmap and known issues]: roadmap.md
 
 ## Overview
@@ -58,8 +58,8 @@ During the migration, Magento converts old BlueFoot content to its PageBuilder e
 The following content types are deprecated in PageBuilder:
 
 * BlueFoot Slider - The Slider content type will be migrated as Advanced Slider.
-* BlueFoot Search - The content for the Search content type will be converted to HTML during migration.
-* BlueFoot Code - The content for the Code content type will be wrapped with the following tags:
+* BlueFoot Search - The content for the Search content block will be converted to HTML during migration.
+* BlueFoot Code - The content for the Code content block will be wrapped with the following tags:
     ```
     <pre><code></code></pre>
     ```
@@ -98,7 +98,7 @@ Your implementation must return a `string` that is compatible with the target co
 | Name              | Description                                     |
 | ----------------- | ----------------------------------------------- |
 | `$itemData`       | Parsed BlueFoot JSON data ready for processing  |
-| `$additionalData` | Additional data for rendering the content type |
+| `$additionalData` | Additional data for rendering the content block |
 
 **Example: Heading renderer class implementation**
 
@@ -177,13 +177,13 @@ class Heading implements RendererInterface
 ```
 
 
-#### Children content types
+#### Children content blocks
 
 Some BlueFoot content types, such as accordion and slider, can contain child content types.
-This can result in trees with deeply nested content types.
+This can result in trees with deeply nested content blocks.
 
 During rendering, content types are processed from the bottom of the tree to the top.
-In other words, the system renders all child content types first and makes the results available to the immediate parent for placement.
+In other words, the system renders all child blocks first and makes the results available to the immediate parent for placement.
 
 Use a virtual type of the following class to get the rendered content for a content type's children:
 
@@ -201,7 +201,7 @@ This class accepts an array of paths, defined in the [`di.xml`] file, which prov
 </virtualType>
 ```
 
-After the system renders the children content types, the content is available to the parent renderer through `$additionalData['children']`.
+After the system renders the children blocks, the content is available to the parent renderer through `$additionalData['children']`.
 
 **Note:**
 *This only applies to content types that contain children.*

app/code/Magento/PageBuilder/docs/content-type-configuration.md

@@ -18,11 +18,11 @@
     1. **Content type configuration**
     1. [How to add a new content type]
     1. [Events]
-    1. [Bindings]
     1. [Master format]
-    1. [Visual select]   
+    1. [Visual select] 
+    1. [Reuse product conditions in content types]
+    1. [Store component master format as widget directive]
     1. [Custom Toolbar] 
-    1. [Add image uploader to content type]
 5. [Roadmap and known issues]
 
 [Introduction]: README.md
@@ -38,11 +38,11 @@
 [Content type configuration]: content-type-configuration.md
 [How to add a new content type]: how-to-add-new-content-type.md
 [Events]: events.md
-[Bindings]: bindings.md
 [Master format]: master-format.md
 [Visual select]: visual-select.md
+[Reuse product conditions in content types]: product-conditions.md
+[Store component master format as widget directive]: widget-directive.md
 [Custom Toolbar]: toolbar.md
-[Add image uploader to content type]: image-uploader.md
 [Roadmap and known issues]: roadmap.md
 
 ## Configuration
@@ -77,7 +77,7 @@ The following is an example of a content type configuration in `view/adminhtml/p
         <icon>icon-pagebuilder-image</icon>
         <component>Magento_PageBuilder/js/content-type</component>
         <preview_component>Magento_PageBuilder/js/content-type/banner/preview</preview_component>
-        <master_component>Magento_PageBuilder/js/content-type/master</master_component>
+        <content_component>Magento_PageBuilder/js/content-type/content</content_component>
         <form>pagebuilder_banner_form</form>
         <group>media</group>
         <allowed_parents>
@@ -197,7 +197,7 @@ The following is an example of a content type configuration in `view/adminhtml/p
 | `icon`              | Icon displayed on the menu.                                                                                                                 |
 | `component`         | View model responsible for rendering the preview and master format.                                                                         |
 | `preview_component` | Helper component that contains preview specific logic. Helper component is optional.                                                        |
-| `master_component`  | Contains master format rendering logic that is generic for all appearances. Content component is optional.                                  |
+| `content_component` | Contains master format rendering logic that is generic for all appearances. Content component is optional.                                  |
 | `form`              | UI component form used for editing the content type                                                                                         |
 | `group`             | Existing menu group that contains this content type.                                                                                        |
 | `allowed_parents`   | List of parent content types that can accept this type as a child.                                                                          |

app/code/Magento/PageBuilder/docs/custom-configuration.md

@@ -15,11 +15,11 @@
     1. [Content type configuration]
     1. [How to add a new content type]
     1. [Events]
-    1. [Bindings]
     1. [Master format]
     1. [Visual select]
+    1. [Reuse product conditions in content types]
+    1. [Store component master format as widget directive]
     1. [Custom Toolbar]
-    1. [Add image uploader to content type]
 5. [Roadmap and known issues]
 
 [Introduction]: README.md
@@ -35,11 +35,11 @@
 [Content type configuration]: content-type-configuration.md
 [How to add a new content type]: how-to-add-new-content-type.md
 [Events]: events.md
-[Bindings]: bindings.md
 [Master format]: master-format.md
 [Visual select]: visual-select.md
+[Reuse product conditions in content types]: product-conditions.md
+[Store component master format as widget directive]: widget-directive.md
 [Custom Toolbar]: toolbar.md
-[Add image uploader to content type]: image-uploader.md
 [Roadmap and known issues]: roadmap.md
 
 
@@ -54,7 +54,7 @@ For example, if you want to load data from the backend, you can use objects, `xs
 
 ## Overview
 
-To add customization to a Page Builder content type, you must:
+To add customization to a Page Builder content type:
 1. [Add additional data to the XML config](#additional-data)
 2. [Implement `ProviderInterface` for conversion](#conversion) (Optional, as it is only required if you're using `xsi:type="object"` to obtain dynamic configuration at runtime)
 
@@ -65,8 +65,6 @@ Use `additional_data` in your `Vendor/ModuleName/view/adminhtml/pagebuilder/cont
 ``` xml
 <additional_data>
     <arguments name="uploaderConfig" xsi:type="array">
-        <item name="isShowImageUploadInstructions" xsi:type="boolean">false</item>
-        <item name="isShowImageUploadOptions" xsi:type="boolean">true</item>
         <item name="maxFileSize" xsi:type="object">Magento\PageBuilder\Model\Config\ContentType\AdditionalData\Provider\Uploader\MaxFileSize</item>
         <item name="allowedExtensions" xsi:type="string">jpg jpeg gif png</item>
         <item name="component" xsi:type="string">Magento_PageBuilder/js/form/element/image-uploader</item>
@@ -132,7 +130,7 @@ In the `additional_data` XML config there is a `storeId` item with a `storeId` p
 <item name="storeId" xsi:type="object">\Magento\PageBuilder\Model\Config\ContentType\AdditionalData\Provider\StoreId</item>
 ```
 
-Custom configuration is injected into relevant content type block constructors, such as for the image block shown here, and accessed in `config.additional_data` within the content type type in `/app/code/Magento/PageBuilder/view/adminhtml/web/js/content-type/<your-content-type>/preview.js`:
+Custom configuration is injected into relevant content type block constructors, such as for the image block shown here, and accessed in `config.additional_data` within the content block type in `/app/code/Magento/PageBuilder/view/adminhtml/web/js/content-type/<your-content-type>/preview.js`:
 
 ``` js
 var uploaderConfiguration = Object.assign(

app/code/Magento/PageBuilder/docs/developer-documentation.md

@@ -15,11 +15,11 @@
     1. [Content type configuration]
     1. [How to add a new content type]
     1. [Events]
-    1. [Bindings]
     1. [Master format]
-    1. [Visual select] 
-    1. [Custom Toolbar]
-    1. [Add image uploader to content type] 
+    1. [Visual select]
+    1. [Reuse product conditions in content types]
+    1. [Store component master format as widget directive]
+    1. [Custom Toolbar] 
 5. [Roadmap and known issues]
 
 **[Architecture overview]** - An overview of the PageBuilder module architecture.
@@ -40,12 +40,14 @@
 
 **[Events]** - Reference documentation for PageBuilder events.
 
-**[Bindings]** - Reference documentation for PageBuilder bindings.
-
 **[Master format]** - Describes the master format for PageBuilder content types.
 
 **[Visual select]** - Documentation on customizing the visual select field.
 
+**[Reuse product conditions in content types]** - Documentation on using the product conditions rule tree for different content types.
+
+**[Store component master format as widget directive]** - Documentation on storing a component's master format as a `widget-directive`.
+
 **[Custom Toolbar]** - Documentation on adding a custom toolbar.
 
 [Introduction]: README.md
@@ -62,7 +64,7 @@
 [Events]: events.md
 [Master format]: master-format.md
 [Visual select]: visual-select.md
+[Reuse product conditions in content types]: product-conditions.md
+[Store component master format as widget directive]: widget-directive.md
 [Custom Toolbar]: toolbar.md
-[Add image uploader to content type]: image-uploader.md
-[Roadmap and known issues]: roadmap.md
-[Bindings]: bindings.md
+[Roadmap and known issues]: roadmap.md