Skip to content

Commit b47372d

Browse files
committed
Merge branch 'MAGEDOC-3583' of github.com:magento-devdocs/magento2-page-builder into MAGEDOC-3583
2 parents f2156fc + 0efa91f commit b47372d

File tree

7 files changed

+19
-19
lines changed

7 files changed

+19
-19
lines changed
Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
# Install Page Builder Examples
22

3-
You can find the code examples used and referred to within this documentation on GitHub in the [pagebuilder-examples repo](https://github.com/magento-devdocs/pagebuilder-examples).
3+
You can find the code examples used, and referred to, within this documentation on GitHub in the [pagebuilder-examples repo](https://github.com/magento-devdocs/pagebuilder-examples).
44
This repo contains two types of examples:
55

66
- Fully functional content type modules
77
- Files for how-to topics
88

99
## Fully functional content type modules
1010

11-
The custom content type modules are here for you to download and install so you can learn by example. These content type modules include the following three:
11+
The following custom content type modules are here for you to download and install so you can learn by example:
1212

13-
- **[PageBuilderQuote](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/PageBuilderQuote)**This is the completed module featured in the [content type tutorial](../create-custom-content-type/overview.md). This module provides an example of a simple content type that provides stylized quotations you can use for things like customer testimonials.
14-
- **[PageBuilderGrid](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/PageBuilderGrid)**This module shows how you can create a content type to rebuild the Magento Luma home page using a grid structure with grid items.
15-
- **[PageBuilderFaq](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/PageBuilderFaq)**This module shows how you can create a content type for an FAQ page that uses an accordion for the questions and answers.
13+
- **[PageBuilderQuote](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/PageBuilderQuote)**—This module shows you how to use a simple content type to stylize quotations for things like customer testimonials. This is the completed module featured in the [content type tutorial](../create-custom-content-type/overview.md).
14+
- **[PageBuilderGrid](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/PageBuilderGrid)**This module shows you how to create a content type to rebuild the Magento Luma home page using a grid structure with grid items.
15+
- **[PageBuilderFaq](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/PageBuilderFaq)**This module shows you how to create a content type for an FAQ page that uses an accordion for the questions and answers.
1616

1717
## Files for how-to topics
1818

19-
This documentation contains several how-to topics for adding features to your content type. The corresponding how-to directories in the repo provide the code changes required for adding the feature to the PageBuilderQuote module.
19+
This documentation contains several how-to topics for adding features to your content type. The corresponding how-to directories in the repo provide the code changes required for adding the feature to the `PageBuilderQuote` module.
2020

21-
For example, the topic [How to add a custom toolbar](../how-to/how-to-add-custom-toolbar.md), has a corresponding directory within the [pagebuilder-examples repo](https://github.com/magento-devdocs/pagebuilder-examples) called [how-to-add-custom-toolbar](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/how-to-add-custom-toolbar). This directory provides the files with the code changes you need to make in order to add a custom toolbar to the PageBuilderQuote module.
21+
For example, the topic [How to add a custom toolbar](../how-to/how-to-add-custom-toolbar.md), has a corresponding directory within the [pagebuilder-examples repo](https://github.com/magento-devdocs/pagebuilder-examples) called [how-to-add-custom-toolbar](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/how-to-add-custom-toolbar). This directory provides the files with the code changes you need to make in order to add a custom toolbar to the `PageBuilderQuote` module.
2222

2323

2424

25-
25+

docs/how-to/how-to-add-block-chooser.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Extends all `abstract` configuration.
1717
<tr>
1818
<td><code>dataUrlConfigPath</code></td>
1919
<td>String</td>
20-
<td>The path inside the Page Builder configuration object that points to the controller URL used to request data for display in the grid. </br>For example, if you utilize the <code>additional_data</code> configuration feature and you add the URL you could specify <code>content_types.mycontenttype.additional_data.my_cusom_property.my_data_url</code>.</td>
20+
<td>The path inside the Page Builder configuration object that points to the controller URL used to request data for display in the grid. </br>For example, if you use the <code>additional_data</code> configuration feature and add the URL, you could specify <code>content_types.mycontenttype.additional_data.my_cusom_property.my_data_url</code>.</td>
2121
</tr>
2222
<tr>
2323
<td><code>requestParameter</code></td>

docs/how-to/how-to-add-icons-images.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Page Builder Admin icons follow the same design principles as the core [Magento
66

77
## Page Builder icons
88

9-
Here are the available Page Builder Admin font icons (with class names) for use within your content type as needed:
9+
Here are the available Page Builder Admin font icons (with class names) for use within your content type:
1010

1111
![Page Builder admin icons](../images/pagebuilder-icons.png){:width="870px" height="auto"}
1212

@@ -106,7 +106,7 @@ The following CSS rule set shows one general way to link your icons through CSS:
106106
}
107107
```
108108

109-
If you are creating an icon for the panel, replace the `background-image` attribute with `content` (as described in the content type tutorial, [Step 6: Add an icon](../create-custom-content-type/step-6-add-icon.md)).
109+
If you create an icon for the panel, replace the `background-image` attribute with `content` (as described in the content type tutorial, [Step 6: Add an icon](../create-custom-content-type/step-6-add-icon.md)).
110110

111111
| Attribute | Description |
112112
| ---------------------- | ------------------------------------------------------------ |

docs/how-to/how-to-deactivate-pagebuilder.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# How to deactivate Page Builder
22

3-
We recommend you deactivate the Page Builder editor through the Admin UI instead of disabling the module through the CLI using `bin/magento`. If you use the CLI, you could break various layouts, for example, the full-width layouts. Deactivating from the Admin UI allows the Page Builder module to continue rendering the content on the storefront even if the editor is not used in the Admin.
3+
We recommend deactivating the Page Builder editor through the Admin UI instead of disabling the module through the CLI using `bin/magento`. If you use the CLI, you could break various layouts, for example, the full-width layouts. Deactivating from the Admin UI allows the Page Builder module to continue rendering the content on the storefront even if the editor is not used in the Admin.
44

5-
Follow these steps to deactivate Page Builder within the Admin UI:
5+
Follow these steps to deactivate Page Builder in the Admin UI:
66

77
1. In the **Stores** tab, select **Configuration** under the Settings group.
88
2. In the **General** group on the page, select **Content Management**.

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# What is Page Builder?
22

33
Page Builder is a Magento extension for creating content with drag-and-drop controls.
4-
We call these controls content types, which provide several key features including:
4+
We call these controls content types, which provide several key features, including:
55

66
- **Dragging-and-dropping** of UI controls to build a page.
77
- **Live previews** of how the content will look on the storefront.

docs/reference/architecture.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ The following is a simple overview of the data flow:
5555

5656
1. Page Builder's reader() reads the data from associated elements in the persisted rendered output of the master format. It does this by traversing through the content type's DOM tree and searching for the associated elements declared in the content types definition XML. Then it uses the various attributes, styles, and other configurations to read the data from the specific area of the DOM element.
5757
2. Page Builder's element converters convert the data for each data mapping entry () to an internal supported format if required, this ensures the data collected from the DOM nodes is compatible with Page Builder's internal data store and UI component fields.
58-
3. Page Builder's mass converters can change data for all content type elements, not just one. For more details see [converter interface](configurations.md).
58+
3. Page Builder's mass converters can change data for all content type elements, not just one. For more details, see [converter interface](configurations.md).
5959
4. Page Builder creates its content types and populates the `Magento_PageBuilder/js/data-store` with data.
6060
5. End-users change the data in the data store within the form editor or when using the various live-editing options on the stage.
6161
6. Page Builder converts the data using mass converters.
@@ -129,14 +129,14 @@ For example:
129129

130130
Page Builder stores data for content types in a simple object called the DataStore: `Magento_PageBuilder/js/data-store`.
131131

132-
The parameter `name` from [content type configuration](configurations.md) is the name of a parameter in the DataStore.
132+
The `name` parameter from the [content type configuration](configurations.md) is the name of a parameter in the `DataStore`.
133133
You can use the `subscribe` method to listen for changes in the DataStore and perform custom actions on the data.
134134

135135
This is how the system binds the data from the DataStore to your elements attribute or style. When you include a new attribute or style, you must specify where it should retrieve its data from the content type. These `name` values normally bind to the field names within UI component forms. The field names are the keys we use to save the data.
136136

137137
## Content type configuration
138138

139-
Please see [content type configuration](configurations.md) for more information.
139+
See [content type configuration](configurations.md) for more information.
140140

141141
## Appearances
142142

docs/reference/configurations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Use the content type and menu section configuration to add new content types, ex
1515
| `children` | List of children content types that can accept this type as a parent. |
1616
| `appearances` | Appearance configuration. |
1717
| `is_system` | Determines menu visibility for the component. System components should not be visible in the menu. Default value is true. |
18-
| `additional_data` | Allows to specify additional data for component, see [additional configurations](../how-to/how-to-add-additional-configurations.md) for more information. |
18+
| `additional_data` | Allows you to specify additional data for the component. See [additional configurations](../how-to/how-to-add-additional-configurations.md) for more information. |
1919
{:style="table-layout:auto"}
2020

2121
| Attribute | Description |
@@ -518,4 +518,4 @@ Individual appearances may have different uiComponent forms in order to use diff
518518
|`fieldsToIgnoreOnRemove`| array containing field names to ignore when evaluating whether an element has been configured. The default value is an empty array. | `["tab_name"]` |
519519
{:style="table-layout:auto"}
520520

521-
<!-- {% endraw %} -->
521+
<!-- {% endraw %} -->

0 commit comments

Comments
 (0)