Merge pull request #214 from magento-devdocs/1.0.0-beta-release

[Owls] Documentation Update

Author: davemacaulay

docs/configurations/iconography.md docs/configurations/icons-and-images.md

@@ -1,4 +1,4 @@
-# Iconography
+# Icons and images
 
 ## Overview
 
@@ -130,4 +130,3 @@ For more general information about Magento's Admin icons and how to create your
 [Magento Admin icons]: https://devdocs.magento.com/guides/v2.2/pattern-library/graphics/iconography/iconography.html
 [Create your own icons]: https://devdocs.magento.com/guides/v2.2/pattern-library/graphics/iconography/iconography.html#creating-icons
 [The CMS icons repository]: https://github.com/magento-ux/cms-icons
-

docs/configurations/responsive-layout-configuration.md

@@ -1,16 +1,15 @@
-# Responsive layouts
+# Overwriting responsive breakpoints
 
-<!-- {% raw %} -->
+This topic describes how to change the default mobile breakpoint in Page Builder.
 
-## What's in this topic
+## Default mobile breakpoint
 
-This topic describes how to use your custom themes to control responsive layouts within Page Builder.
-
-## Responsive Mobile Images
-
-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 less than the industry-standard max-width of 768px. This width is configured within `Magento_PageBuilder/etc/view.xml`, as follows:
+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:
 
 ```xml
+<?xml version="1.0"?>
+<view xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Config/etc/view.xsd">
+...
 <vars module="Magento_PageBuilder">
     <var name="breakpoints">
         <var name="mobile">
@@ -22,24 +21,32 @@ By default, when you configure Page Builder to render a background image for a c
 </vars>
 ```
 
-If your custom theme also uses this max-width breakpoint for your mobile layout, no additional configuration is required.
+## Changing the mobile breakpoint
+
+If your custom theme also uses this max-width breakpoint for your mobile layout, no changes are required.
+
+However, if your custom theme uses a different mobile breakpoint, you need to overwrite the default breakpoint by either: 
 
-However, if your custom theme uses a different mobile breakpoint, you'll need to add that breakpoint (in pixels) to your theme's `view.xml` by including the following XML within the `<view />` node, and replacing `CUSTOM-BREAKPOINT` with the integer value of your theme's breakpoint, as follows:
+1. Adding the theme's breakpoint to the theme's `view.xml` file.
+2. Adding a `view.xml` file in the `etc` directory of your content type as shown here:
+
+    ![product conditions](../images/how-to-change-breakpoint.png "Add view.xml file")
+
+In either case, if your theme uses a mobile breakpoint `max-width` of `600px`, you would add the following markup to the `view.xml` file:
 
 ```xml
-<vars module="Magento_PageBuilder">
-    <var name="breakpoints">
-        <var name="mobile">
-            <var name="conditions">
-                <var name="max-width">CUSTOM-BREAKPOINTpx</var>
+<?xml version="1.0"?>
+<view xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Config/etc/view.xsd">
+    <vars module="Magento_PageBuilder">
+        <var name="breakpoints">
+            <var name="mobile">
+                <var name="conditions">
+                    <var name="max-width">600px</var>
+                </var>
             </var>
         </var>
-    </var>
-</vars>
+    </vars>
+</view>
 ```
 
-This directs Page Builder to use your theme's mobile breakpoint instead of its default breakpoint of 768px. Other responsive breakpoints from your custom theme can be added in the same way.
-
-[Note: I think it might be nice to include another example or two of configuring other breakpoints (or other styles?) from custom themes as relevant.]
-
-<!-- {% endraw %} -->
+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.

docs/configurations/storefront-configuration.md

@@ -49,7 +49,7 @@ The XML configuration loads the widget on the frontend, and on the stage, so tha
 Add the following configuration to the `etc/di.xml` file in your custom module directory:
 
 ``` xml
-<type name="Magento\PageBuilder\Model\Config\ContentType\WidgetInitializer">
+<type name="Magento\PageBuilder\Model\WidgetInitializerConfig">
     <arguments>
         <argument name="config" xsi:type="array">
             <item name="%content-type-name%" xsi:type="array">

docs/getting-started/introduction.md

@@ -37,7 +37,7 @@ See [Install Page Builder](install-pagebuilder.md)
 * [Additional configurations](../configurations/additional-configurations.md)
 * [Panel configurations](../configurations/panel-configurations.md)
 * [Option menu configurations](../configurations/option-menu-configurations.md)
-* [Iconography](../configurations/iconography.md)
+* [Icons and images](../configurations/icons-and-images.md)
 * [Block chooser configuration](../configurations/block-chooser-configuration.md)
 * [Full-width page layout configuration](../configurations/full-width-page-layout-configuration.md)
 * [Responsive layout configuration](../configurations/responsive-layout-configuration.md)
@@ -87,5 +87,4 @@ We will push new beta releases once a week, including work from the backlog. We
 
 To participate in technical discussions and ask questions, join us in [Slack], where a number of Page Builder team members are present.
 
-
 [Slack]: https://magentocommeng.slack.com/messages/GANS1R4C9

docs/how-to/how-to-convert-product-attributes-to-use-pagebuilder.md

@@ -2,8 +2,8 @@
 
 ## Product attribute fields
 
-The PageBuilder module is compatible with all product attributes fields that use an input of type `text`.
-If your module creates a custom product attribute as a feature, you can change the input of that attribute to PageBuilder.
+The Page Builder module is compatible with all product attribute fields that use an input of type `text`.
+If your module creates a custom product attribute as a feature, you can change the input of that attribute to Page Builder.
 
 For example, the following code creates a new product attribute called "Sample Field" with a default input type of `textarea`.
 
@@ -45,7 +45,7 @@ $categorySetup->addAttribute(
 );
 ```
 
-The following steps changes a custom product attribute's input type to PageBuilder using the Admin:
+The following steps change a custom product attribute's input type to PageBuilder using the Admin:
 
 1. On the Admin sidebar, click **Stores**.
 2. Under **Attributes**, click on **Product**.
@@ -59,11 +59,11 @@ The following steps changes a custom product attribute's input type to PageBuild
 
 All form fields that use the [WYSIWYG UI Component] are compatible with the PageBuilder module.
 
-The following configuration settings in your module's [UI Component configuration file] affect how a form field interacts with the PageBuilder module:
+The following configuration settings in your module's [UI Component configuration file] affect how a form field interacts with the Page Builder module:
 
 ### `pagebuilder_button`
 
-The `pagebuilder_button` configuration determines the appearance of the PageBuilder editor.
+The `pagebuilder_button` configuration determines the appearance of the Page Builder editor.
 
 When this configuration is set to `true`, a button replaces the input field on the form.
 This button launches the PageBuilder editor in Full Screen Mode when clicked.
@@ -94,9 +94,9 @@ When this configuration is not specified or set to `false`, the PageBuilder edit
 
 ### `is_pagebuilder_enabled`
 
-When the PageBuilder module is enabled, all form fields that use the [WYSIWYG UI Component] automatically switch to PageBuilder.
+When the PageBuilder module is enabled, all form fields that use the [WYSIWYG UI Component] automatically switch to Page Builder.
 
-To prevent your form field from switching or using PageBuilder, set the `is_pagebuilder_enabled` configuration to `false`.
+To prevent your form field from switching or using Page Builder, set the `is_pagebuilder_enabled` configuration to `false`.
 
 **Example:**
 

docs/images/how-to-change-breakpoint.png

@@ -0,0 +1,90 @@
+# PageBuilder Early Adopters Program
+
+The Page Builder Early Adopters Program (EAP) gives partners the following perks:
+ 
+* Explore extension points to build custom modules and integrations for 3rd party services, such as Facebook and Instagram.
+* Try out customization options and extend its functionality beyond its default features.
+* Preview to prepare a migration plan from BlueFoot 1.0 to PageBuilder.
+
+## Installation
+
+See [Install Page Builder](getting-started/install-pagebuilder.md)
+
+<!-- {% comment %} -->
+
+## Developer documentation
+
+### Getting started
+
+* [Install Page Builder](getting-started/install-pagebuilder.md)
+* [Activate Page Builder](getting-started/activate-pagebuilder.md)
+* [View Page Builder](getting-started/view-pagebuilder.md)
+
+### Create a content type
+
+* [Overview](create-basic-content-type/overview.md)
+* [Step 1: Add configuration](create-basic-content-type/step-1-add-configuration.md)
+* [Step 2: Add templates](create-basic-content-type/step-2-add-templates.md)
+* [Step 3: Add components](create-basic-content-type/step-3-add-components.md)
+* [Step 4: Add form](create-basic-content-type/step-4-add-form.md)
+* [Step 5: Add styles](create-basic-content-type/step-5-add-styles.md)
+* [Step 6: Add an icon](create-basic-content-type/step-6-add-icon.md)
+* [What's next](create-basic-content-type/whats-next.md)
+
+### Configurations
+
+* [Main configurations](configurations/content-type-configuration.md)
+* [Additional configurations](configurations/additional-configurations.md)
+* [Panel configurations](configurations/panel-configurations.md)
+* [Option menu configurations](configurations/option-menu-configurations.md)
+* [Icons and images](configurations/icons-and-images.md)
+* [Block chooser configuration](configurations/block-chooser-configuration.md)
+* [Full-width page layout configuration](configurations/full-width-page-layout-configuration.md)
+* [Responsive layout configuration](configurations/responsive-layout-configuration.md)
+* [Storefront configuration](configurations/storefront-configuration.md)
+* [Selector configuration](configurations/selector-configuration.md)
+* [Product conditions configuration](configurations/product-conditions-configuration.md)
+* [Server-side rendered previews](configurations/server-side-rendered-previews.md)
+
+### How tos
+
+* [How to develop a container content type](how-to/how-to-develop-container-content-type.md)
+* [How to use the Image Uploader](how-to/how-to-use-image-uploader.md)
+* [How to use the Image Uploader](how-to/how-to-use-image-uploader.md)
+* [How to add inline text editing](how-to/how-to-add-inline-text-editing.md)
+* [How to add a custom toolbar](how-to/how-to-add-custom-toolbar.md)
+* [How to convert product attribute fields to use Page Builder](how-to/how-to-convert-product-attributes-to-use-pagebuilder.md)
+* [How to store a component master format as a widget-directive](how-to/how-to-store-master-format-as-widget-directive.md)
+
+### Reference
+
+* [Architecture](reference/architecture.md)
+* [Events](reference/events.md)
+* [Knockout bindings](reference/knockout-bindings.md)
+
+### Migration
+
+* [Migrate from BlueFoot](migration/migrate-from-bluefoot.md)
+* [Migrate custom content types from BlueFoot](migration/migrate-custom-content-types-from-bluefoot.md)
+
+### Other
+
+* [Release notes](release-notes.md)
+* [Component status](comp-status2.md)
+* [Contribution guide](https://github.com/magento/magento2-page-builder/blob/develop/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).
+
+## Page Builder updates from the Magento core team
+
+We will push new beta releases once a week, including work from the backlog. We don't expect any large breaking changes, but we will communicate them to you if the need arises.
+
+## Contact us
+
+To participate in technical discussions and ask questions, join us in [Slack], where a number of Page Builder team members are present.
+
+[Slack]: https://magentocommeng.slack.com/messages/GANS1R4C9

docs/index.md

@@ -1,8 +1,8 @@
 label: Page Builder
+url: /page-builder/
+versionless: true
 pages:
 - label: Getting started
-  url: /page-builder/getting-started/introduction.html
-  versionless: true
   children:
   - label: Install Page Builder
     url: /page-builder/getting-started/install-pagebuilder.html
@@ -43,8 +43,8 @@ pages:
     url: /page-builder/create-basic-content-type/step-5-add-styles.html
     versionless: true
 
-  - label: Step 6. Add frontend widget
-    url: /page-builder/create-basic-content-type/step-6-add-frontend-widget.html
+  - label: Step 6. Add an icon
+    url: /page-builder/create-basic-content-type/step-6-add-icon.html
     versionless: true
 
   - label: What's next?
@@ -70,8 +70,8 @@ pages:
     url: /page-builder/configurations/option-menu-configurations.html
     versionless: true
 
-  - label: Iconography
-    url: /page-builder/configurations/iconography.html
+  - label: Icons and images
+    url: /page-builder/configurations/icons-and-images.html
     versionless: true
 
   - label: Block chooser
@@ -105,10 +105,6 @@ pages:
 - label: How tos
   versionless: true
   children:
-  - label: How to develop a new content type
-    url: /page-builder/how-to/how-to-develop-new-content-type.html
-    versionless: true
-
   - label: How to develop a container content type
     url: /page-builder/how-to/how-to-develop-container-content-type.html
     versionless: true
@@ -148,10 +144,6 @@ pages:
     url: /page-builder/reference/knockout-bindings.html
     versionless: true
 
-  - label: Master format
-    url: /page-builder/reference/master-format.html
-    versionless: true
-
 - label: Migration to Page Builder
   versionless: true
   children:
@@ -163,14 +155,14 @@ pages:
     url: /page-builder/migration/migrate-custom-content-types-from-bluefoot.html
     versionless: true
 
-- label: Component status
-  url: /page-builder/component-status.html
+- label: Release notes
+  url: /page-builder/release-notes.html
   versionless: true
 
-- label: Known issues
-  url: /page-builder/known-issues.html
+- label: Component status
+  url: /page-builder/comp-status2.html
   versionless: true
 
 - label: Contribution guide
   url: https://github.com/magento/magento2-page-builder/blob/develop/CONTRIBUTING.md
-  versionless: true
+  versionless: true