Merge branch 'develop' into MC-3330

dhaecker · dhaecker · commit 254adc1522e6 · 2019-02-28T14:50:10.000-06:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
diff --git a/docs/_config.checks.yml b/docs/_config.checks.yml
@@ -0,0 +1,35 @@
+# Configuration settings for html-proofer.
+# For configuration documentation, refer to: https://github.com/gjtorikian/html-proofer#configuration
+# For configuration defaults, refer to: https://github.com/gjtorikian/html-proofer/blob/master/lib/html-proofer/configuration.rb
+#
+html-proofer:
+  :disable_external: true
+  :only_4xx: true
+  :empty_alt_ignore: true
+  :allow_hash_ref: true
+  :error_sort: :desc
+  :parallel:
+    :in_processes: 3
+  :file_ignore:
+  - !ruby/regexp /guides\/m1x/
+  - !ruby/regexp /guides\/v2\.0/
+  - !ruby/regexp /videos\//
+  :url_ignore:
+  - !ruby/regexp /guides\/m1x/
+  - !ruby/regexp /guides\/v2\.0/
+  - !ruby/regexp /videos\//
+  - !ruby/regexp /guides\//
+  - !ruby/regexp /mftf\//
+  - !ruby/regexp /common\//
+  - !ruby/regexp /community\//
+  - !ruby/regexp /mftf\//
+  - !ruby/regexp /redoc\//
+  - !ruby/regexp /swagger\//
+  - !ruby/regexp /whatsnew.html/
+  - !ruby/regexp /availability.html/
+  - !ruby/regexp /magento-techbull.html/
+  - !ruby/regexp /magento-third-party.html/
+  - !ruby/regexp /whatsnew.html/
+  - !ruby/regexp /search.html/
+  - !ruby/regexp /system-requirements.html/
+  - !ruby/regexp /feed.xml/
diff --git a/docs/_config.page-builder.yml b/docs/_config.page-builder.yml
@@ -1 +1,2 @@
-exclude:
+exclude:
+
diff --git a/docs/_includes/page-builder/release-notes/beta-1.md b/docs/_includes/page-builder/release-notes/beta-1.md
@@ -0,0 +1,15 @@
+
+## Beta 1 - November 27, 2018
+
+- Initial beta release
+
+## Known Issues
+
+* Degraded admin experience when using IE 11.
+* Product does not display in admin when it is assigned to a specific website. <!-- MC-5373 -->
+* Issues with padding, margins, and box-sizing on numerous content types. <!-- MC-11021 -->
+* Floating option menus and other controls can be displayed off screen when content types are rendered near the edge of the screen. <!-- MC-5383 -->
+* Degraded Parallax performance on storefront and in admin within some browsers. <!-- MC-5480 -->
+* Using Page Builder within a slide out form has a degraded experience.
+    * Left-side panel will not scroll with the user.
+    * Dragging and dropping can become broken due to another instance of Page Builder being loaded.
diff --git a/docs/_includes/page-builder/release-notes/beta-2.md b/docs/_includes/page-builder/release-notes/beta-2.md
@@ -0,0 +1,11 @@
+## Beta 2 - December 10, 2018
+
+- Resolved: Image inside Text Content Type is scaled on stage <!-- MC-3509 --> 
+- Resolved: Padding is not respected on Text <!-- MC-3713 --> 
+- Resolved: Saving Slide Button Type As Secondary Or Link Will Still Show As Primary On Edit Form <!-- MC-3818 --> 
+- Resolved: Columns Widths Are Not Consistent Between Stage & Storefront <!-- MC-3992 --> 
+- Resolved: Review Information Covered By Add To Cart Button On Products On Stage <!-- MC-4130 --> 
+- Resolved: Hard Coded Padding On Button Groups & On Text <!-- MC-4278 --> 
+- Resolved: Remove Reset Button From Slide Outs For All Content Types <!-- MC-5790 --> 
+- Resolved: Remove is_hideable option from content type configuration <!-- MC-4959 --> 
+- Resolved: IE11 - Cannot Use Slide Item Option Menu <!-- MC-5443 --> 
diff --git a/docs/_includes/page-builder/release-notes/beta-3.md b/docs/_includes/page-builder/release-notes/beta-3.md
@@ -0,0 +1,8 @@
+## Beta 3 - December 19, 2018
+
+- Improved: Handling of invalid Google Maps API keys <!-- MC-5723 -->
+- Removed: Legacy overlay transparency field from banner & slider in favor of using the color picker <!-- MC-3895 -->
+- Resolved: Box sizing issues on storefront and Admin <!-- MC-5079 --> 
+- Resolved: Issue with initiation of tabs breaking in certain scenarios <!-- MC-5363 --> 
+- Resolved: Performance issues with "Edit with Page Builder" button in category and product areas <!-- MC-5403 --> 
+- Resolved: Numerous issues within staging slide out <!-- MC-5423 --> 
diff --git a/docs/_includes/page-builder/release-notes/beta-4.md b/docs/_includes/page-builder/release-notes/beta-4.md
@@ -0,0 +1,5 @@
+## Beta 4 - January 14, 2019
+
+- Resolved: Collage Center/Left/Right does not work correctly in a container smaller than 100% width <!-- MC-5372 -->
+- Resolved: Contained row appearance renders too small when in smaller container or in Block/Dynamic Block <!-- MC-5432 -->
+- Resolved: XSS Vulnerability in Page Builder <!-- MC-5835 -->
diff --git a/docs/_includes/page-builder/release-notes/beta-5.md b/docs/_includes/page-builder/release-notes/beta-5.md
@@ -0,0 +1,8 @@
+## Beta 5 - January 28, 2019
+
+- Resolved: Prefixed field names with section name to avoid field name collision <!-- MC-5232 -->
+- Resolved: MFTF: Rewrite Selectors/ActionGroups to allow using PageBuilder in non-CMS page areas <!-- MC-4231 -->
+- Resolved: Right/Left Margin Not Working For Content Types <!-- MC-5025 -->
+- Resolved: Alignment doesn't work for Slide, Banners, & Text Placeholders & for Slide Content & Banner Poster Content <!-- MMC-4290 -->
+- Resolved: Implement better developer error reporting <!-- MC-5691 -->
+- Resolved: Banner placeholder disappears when user switching between different appearances <!-- MC-5727 -->
diff --git a/docs/_includes/page-builder/release-notes/beta-6.md b/docs/_includes/page-builder/release-notes/beta-6.md
@@ -0,0 +1,9 @@
+## Beta 6 - February 4, 2019
+
+- Resolved: Background attachments of "fixed" do not work in storefront on Android or iPhone mobile devices<!-- MC-5419 -->
+- Resolved: Minimum height issues with Columns <!-- MC-5405 -->
+- Resolved: Parallax fixed settings should work in admin and storefront <!-- MC-11066 -->
+- Resolved: Move data migration into its own module <!-- MC-5824 -->
+- Resolved: Changing row appearance with two rows on stage breaks admin <!-- MC-11821 -->
+- Resolved: Banner and Slider TinyMCE menus display inconsistently in admin <!-- MC-13691 -->
+- Improved: Test coverage for CMS Blocks and Catalog Product <!-- MC-3328, MC3329 -->
diff --git a/docs/_includes/page-builder/release-notes/beta-7.md b/docs/_includes/page-builder/release-notes/beta-7.md
@@ -0,0 +1,17 @@
+## Beta 7 - February 14, 2019
+
+Beta 7 has breaking changes due to renaming of several critical variables and parameters in Page Builder's code and configuration. Please refer to the [breaking changes document](https://devdocs.magedevteam.com/ds_pagebuilder/page-builder/breaking-changes.html) for details on how to update your custom content types.
+
+- Resolved: Content type markup within Text content type causes whole stage to become HTML <!--MC-13917-->
+- Resolved: Hard-coded margins on individual Button <!--MC-13925-->
+- Resolved: Various TypeScript errors <!--MC-10833-->
+- Resolved: Column rearranging drop zone indicators are too small and sometimes hard to activate <!--MC-4262-->
+- Resolved: Collect Page Builder content type data for Page Builder analytics <!--MC-1426-->
+- Resolved: Improve naming of the critical variables/parameters in the code and configuration <!--MC-5810-->
+- Resolved: Text height inconsistency on stage and storefront <!--MC-4254-->
+- Resolved: Option menus, Heading inline editor, and tinyMCE inline editor are cut off on full screen view <!--MC-5383-->
+- Resolved: Anchor tags for TinyMCE links are not added to the storefront for Banners and Slides (Added notification for when link attribute is entered) <!--MC-5386-->
+- Resolved: `WidgetInitializerConfig` only supports <div /> elements <!--MC-13770-->
+- Resolved: Slide dots are hard to see against certain backgrounds on storefront <!--MC-5701-->
+- Resolved: Missing validation message when uploading big image <!--MC-5184-->
+- Resolved: Security issues <!--MC-10871, MC-13922-->
diff --git a/docs/_includes/page-builder/release-notes/beta-8.md b/docs/_includes/page-builder/release-notes/beta-8.md
@@ -0,0 +1,3 @@
+## Beta 8 - February 19, 2019
+
+- Resolved: Analytics module sequence issue.
diff --git a/docs/_includes/page-builder/release-notes/intro.md b/docs/_includes/page-builder/release-notes/intro.md
@@ -0,0 +1 @@
+Here are the Page Builder beta release notes and the higher priority known issues. We are actively working on many of these items and will update this document with each beta release.
diff --git a/docs/breaking-changes.md b/docs/breaking-changes.md
@@ -0,0 +1,91 @@
+# Breaking changes in 1.0.0-beta7
+
+As hard as we tried to avoid breaking changes during our beta program, we felt compelled to clarify certain names within Page Builder to help developers better understand their purpose. As a result these changes **will break** existing content within previous beta versions, along with any custom content types you've created.
+
+A summary of the changes is shown here, followed by the details on how to update your existing content:
+
+- `data-role` to `data-content-type`
+- `group` to `menu_section`
+- `render_template` to `master_template`
+- `is_visible` to `is_system`
+- `renderChildTemplate` to `masterTemplate`
+- `previewChildTemplate` to `childTemplate`
+- `renderTemplate` and `previewTemplate` to `template`
+
+We’re sorry if these changes cause you any disruption. But we strongly believe they will improve product understanding for all future developers.
+
+## Master Format Changes
+
+The `data-role` attribute is now called `data-content-type`.  We strongly believe this makes understanding the purpose of the element and attribute much easier, as `data-role` is already used for several other features in Magento.
+
+This change causes existing content to load as HTML code within your content type. To fix this issue, run the following command on your MySQL database:
+
+```sql
+UPDATE cms_page SET content = REPLACE(content, 'data-role="', 'data-content-type="');
+UPDATE cms_block SET content = REPLACE(content, 'data-role="', 'data-content-type="');
+UPDATE magento_banner_content SET banner_content = REPLACE(banner_content, 'data-role="', 'data-content-type="');
+UPDATE catalog_category_entity_text SET value = REPLACE(value, 'data-role="', 'data-content-type="');
+UPDATE catalog_product_entity_text SET value = REPLACE(value, 'data-role="', 'data-content-type="');
+```
+
+## XML Changes
+
+The `group` system has been renamed to `menu_section`, resulting in the following changes:
+
+- The `group.xml`, `group.xsd`, and `group_merged.xsd` files are now called `menu_section.xml`, `menu_section.xsd`, and `menu_section_merged.xsd`, but are located in the same places and have the same purposes. Nodes within these files have also been updated from `<group />` to `<menu_section />`.
+
+- The `group` attribute is now called `menu_section`. If you've implemented a custom content type, you will need to update this attribute within your content type's configuration file. For example:
+
+  ```xml
+  <type name="example_quote"
+              label="Quote"
+              menu_section="elements"
+  ```
+
+- For any panel extensions you may have done, you will need to change your panel import references from `Magento_PageBuilder/js/panel/group` to `Magento_PageBuilder/js/panel/menuSections`, as well as any reader class references from `Magento\PageBuilder\Model\Config\Group` classes to `Magento\PageBuilder\Model\Config\MenuSection` classes, as necessary.
+
+## JavaScript Changes
+
+We've also improved the naming of various properties in the JavaScript classes we ship within Page Builder. These changes may result in your custom extensions referencing properties that are no longer available.
+
+- A content type's parent content type is now referenced as `parentContentType` instead of just `parent`, this was changed in `content-type.ts` and `content-type-collection.ts`. If you're traversing up the tree you will need to update this reference.
+
+- From the `preview` and `master` components, you now access the content type instance through `contentType` instead of previously using `parent`. For example, event code using `parent` will need to be updated to contentType:
+
+  ```js
+  events.on(`${this.config.name}:${this.parent.id}:updateAfter`, function (args) {
+       console.log(self.parent);
+  });
+  ```
+
+  Changes to:
+
+  ```js
+  events.on(`${this.config.name}:${this.contentType.id}:updateAfter`, function (args) {
+       console.log(self.contentType);
+  });
+  ```
+
+- `render_template` is renamed to `master_template`:
+
+  ```xml
+   <appearance name="default"
+               preview_template="Example_PageBuilderQuote/content-type/example-quote/default/preview"
+               render_template="Example_PageBuilderQuote/content-type/example-quote/default/master"
+               reader="Magento_PageBuilder/js/master-format/read/configurable">
+  ```
+
+  Changes to:
+
+  ```xml
+   <appearance name="default"
+               preview_template="Example_PageBuilderQuote/content-type/example-quote/default/preview"
+               master_template="Example_PageBuilderQuote/content-type/example-quote/default/master"
+               reader="Magento_PageBuilder/js/master-format/read/configurable">
+  ```
+
+  
+
+- `is_visible` is renamed to `is_system`. If your content type modifies this attribute, you will need to update your reference in the configuration file.
+
+- `renderChildTemplate` is renamed to `masterTemplate` and `previewChildTemplate` is renamed to `childTemplate`. If you have a container content type which renders children, you will need to update these references in your code.
diff --git a/docs/comp-status2.md b/docs/comp-status2.md
@@ -1,6 +1,6 @@
 # Component status
 
-**Last Updated: January 14, 2019**
+**Last Updated: February 14, 2019**
 
 <style type="text/css" style="display: none">
 .status {
diff --git a/docs/configurations/panel-configurations.md b/docs/configurations/panel-configurations.md
@@ -17,10 +17,11 @@ These menu sections are defined in the Page Builder `menu_section.xml` file and
 ## Overview
 
 This topic describes four ways to customize the Page Builder panel:
-    - [Rename panel menu sections](#rename-panel-menu-sections)
-    - [Reorder panel menu sections](#reorder-panel-menu-sections)
-    - [Add new panel menu sections](#add-new-panel-menu-sections)
-    - [Add content types to different panel menu sections](#add-content-types-to-different-panel-menu-sections)
+
+- [Rename panel menu sections](#rename-panel-menu-sections)
+- [Reorder panel menu sections](#reorder-panel-menu-sections)
+- [Add new panel menu sections](#add-new-panel-menu-sections)
+- [Add content types to different panel menu sections](#add-content-types-to-different-panel-menu-sections)
 
 {: .bs-callout .bs-callout-info }
 For the sake of the user experience, please don't forget the affect your panel configurations may have on the end user. User's should have access the most important content types first, so be careful how you reorder menu sections and content types within menu sections. We strongly encourage you to place your content types into the existing menu sections when possible, instead of creating your own menu section.
@@ -67,7 +68,7 @@ The result looks like this:
 
 ![Reorder panel menu sections](../images/panel-reorder-menu-sections.png)
 
-## Add new panel menu section
+## Add new panel menu sections
 
 To add a new panel menu section, add a new `<menu_section>` element  in your module's `menu_section.xml` file with a unique `name` as shown here:
 
diff --git a/docs/configurations/responsive-layout-configuration.md b/docs/configurations/responsive-layout-configuration.md
@@ -4,7 +4,7 @@ This topic describes how to change the default mobile breakpoint in Page Builder
 
 ## Default mobile breakpoint
 
-By default, when you configure Page Builder to render a background image for a container, it uses a mobile image when the container's width is equal to and less than 768px. Page Builder defines this mobile breakpoint in the `Magento_PageBuilder/etc/view.xml` file, as shown here:
+By default, when you configure Page Builder to render a background image for a container, it uses a mobile image when the container's width is equal to or less than 768px. Page Builder defines this mobile breakpoint in the `Magento_PageBuilder/etc/view.xml` file, as shown here:
 
 ```xml
 <?xml version="1.0"?>
@@ -49,4 +49,4 @@ In either case, if your theme uses a mobile breakpoint `max-width` of `600px`, y
 </view>
 ```
 
-This directs Page Builder to use this mobile breakpoint instead of its default breakpoint of 768px. Other responsive breakpoints from your custom theme can be added in the same way.
+This directs Page Builder to use this mobile breakpoint instead of its default breakpoint of 768px. You can add other responsive breakpoints from your custom theme in the same way.
diff --git a/docs/create-basic-content-type/overview.md b/docs/create-basic-content-type/overview.md
@@ -28,7 +28,7 @@ After registering your module (`bin/magento setup:upgrade`) you will be ready to
 
 The steps for creating the Quote content type are illustrated and described below. The reality is not quite this linear, but these steps do represent the basic phases and flow for building new Page Builder content types.
 
-![Creating Custom Content Types](../images/content-type-overview.svg)
+![Creating Custom Content Types](../images/content-type-overview.png)
 
 1. **Add configuration**: Create an XML file to define your content type and reference the other files that control the appearance and behavior of your content type.  
 2. **Add templates**: Create HTML templates that define the appearance of your content types on the Admin stage (`preview.html`) and the storefront (`master.html`).
diff --git a/docs/getting-started/introduction.md b/docs/getting-started/introduction.md
@@ -71,13 +71,13 @@ See [Install Page Builder](install-pagebuilder.md)
 
 * [Release notes](../release-notes.md)
 * [Component status](../comp-status2.md)
-* [Contribution guide](https://github.com/magento/magento2-page-builder/blob/develop/CONTRIBUTING.md)
+* [Contribution guide](../../CONTRIBUTING.md)
 
 <!-- {% endcomment %} -->
 
 ## Contribute to Page Builder
 
-We appreciate any and all contributions to PageBuilder. If you are interested in contributing to this repository, please see our [Contribution guide](https://github.com/magento/magento2-page-builder/blob/develop/CONTRIBUTING.md).
+We appreciate any and all contributions to PageBuilder. If you are interested in contributing to this repository, please see our [Contribution guide](https://github.com/magento/magento2-page-builder/CONTRIBUTING.md).
 
 ## Page Builder updates from the Magento core team
 
diff --git a/docs/how-to/how-to-add-custom-toolbar.md b/docs/how-to/how-to-add-custom-toolbar.md
diff --git a/docs/images/how-toolbars-work.png b/docs/images/how-toolbars-work.png
diff --git a/docs/images/how-toolbars-work.svg b/docs/images/how-toolbars-work.svg
diff --git a/docs/page-builder.yml b/docs/page-builder.yml
diff --git a/docs/reference/architecture.md b/docs/reference/architecture.md
diff --git a/docs/reference/events.md b/docs/reference/events.md
diff --git a/docs/release-notes.md b/docs/release-notes.md
