Skip to content

Commit 8cf13f4

Browse files
MAGEDOC-3644: Post GA release docs cleanup
Fixes from review Co-Authored-By: bdenham <bdenham@adobe.com>
1 parent b0c4ad0 commit 8cf13f4

File tree

6 files changed

+11
-11
lines changed

6 files changed

+11
-11
lines changed

docs/create-custom-content-type/summary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
If you made it this far, congratulations! We hope this tutorial was useful for learning the basics of creating a completely new content type for your end users.
44

55
## Next topics
6-
Here's a list of good next topics to learn more about customizing Page Builder:
6+
Review the following topics to learn more about customizing Page Builder:
77

88
### Tutorials
99

docs/extend-existing-content-type/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Overview
22

3-
One of the quickest ways to customize Page Builder is by changing how _existing_ content types look and behave. End-users can already use Page Builder's content types to customize their content using the form editor. But sometimes your end-users will want to change the structure or set properties that do not exist on the content type. In those cases, you can extend an existing content type by customizing its existing _appearance_ or adding a new _appearance_.
3+
One of the quickest ways to customize Page Builder is by changing how _existing_ content types look and behave. End users can already use Page Builder's content types to customize their content using the form editor. But your end users may want to change the structure or set properties that do not exist on the content type. In those cases, you can extend an existing content type by customizing its _appearance_ or adding a new _appearance_.
44

55
## Appearances
66

7-
An **appearance** is an XML element (in the content type's config file) that defines a view for your content type. This view defines HTML templates, styles, form fields, and other elements, which you can customize in various ways. To extend existing Page Builder content types, you can either modify existing appearances or create new ones.
7+
An **appearance** is an XML element (in the content type's configuration file) that defines a view for your content type. This view defines HTML templates, styles, form fields, and other elements that you can customize in various ways. To extend existing Page Builder content types, you can either modify existing appearances or create new ones.
88

99
Many of Page Builder's content types have only one `appearance` element. These include the Heading, Text, Image, Video, Tabs, and more. Other content types have several appearances. For example, the Banner content type has four appearances, as shown here:
1010

docs/extend-existing-content-type/step-2-extend-appearances.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Step 2: Extend appearances
22

3-
In this step, you will extend all four Banner appearances by adding a new `max_height` style to each. The max-height property stops the Banner from growing beyond a certain height as end-users enter banner text.
3+
In this step, you will extend all four Banner appearances by adding a new `max_height` style to each. The `max-height` property stops the Banner from growing beyond a certain height as end users enter banner text.
44

55
## Create a content configuration file
66

@@ -15,13 +15,13 @@ As mentioned before, Page Builder defines the Banner's appearances within the `b
1515
</appearances>
1616
```
1717

18-
To customize these appearances, we need to create a new configuration file named `banner.xml`. Our configuration file must be the same name as the Banner's configuration file. This ensures that Magento merges our appearance customizations with the Banner's existing configuration. Your file structure for the `banner.xml` extension should look like this:
18+
To customize these appearances, you must create a new configuration file named `banner.xml`. The configuration file must use the same name as the Banner's configuration file. This ensures that Magento merges the appearance customizations with the Banner's existing configuration. Your file structure for the `banner.xml` extension should look like this:
1919

2020
![Extension config file structure](../images/appearance-extension-config-file.png){:width="511px" height="auto"}
2121

2222
## Add properties to appearances
2323

24-
In the Page Builder 1.0.0 release, you cannot extend just one appearance of a content type. You must extend them all. In our example, we are extending all four appearances of the Banner content type by adding a max-height style property to these appearances:
24+
In the Page Builder 1.0.0, you cannot extend just one appearance of a content type. You must extend them all. In the following example, we are extending all four appearances of the Banner content type by adding a `max-height` style property to these appearances:
2525

2626
```xml
2727
<?xml version="1.0"?>

docs/extend-existing-content-type/step-3-extend-forms.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,10 +93,10 @@ The following table describes some key elements:
9393
| `settings` | Provides the markup that gives your field a label, CSS styling, validation, and other properties as needed. |
9494
{:style="table-layout:auto"}
9595

96-
After adding the max_height field, flush your cache, drag a banner to the Admin stage, open the editor, and see your new style property field being rendered in the Banner's form, as shown here:
96+
After adding the `max_height` field, flush your cache, drag a banner to the Admin stage, open the editor, and see your new style property field being rendered in the Banner's form, as shown here:
9797

9898
![Appearance fieldset](../images/appearance-fieldset.png){:width="934px" height="auto"}
9999

100100
## Conclusion
101101

102-
That's it! You should now be familiar with the basics of extending an existing content type. There is much more to learn, but we hope this gives you a better understanding of how you can customize the existing Page Builder content types to fit your end-user's needs.
102+
That's it! You should now be familiar with the basics of extending an existing content type. There is much more to learn, but we hope this gives you a better understanding of how you can customize the existing Page Builder content types to fit your end-user's needs.

docs/reference/knockout-bindings.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ view/adminhtml/web/ts/js/binding/draggable.ts
4141

4242
This binding serves as an interface for jQuery UI Draggable.
4343

44-
Within Page Builder, we use this binding for the left panel's content types. The configuration and usage of the `draggable` binding can be seen in the Panel component. If you have access to the Page Builder repo, you can find the Panel component template here: https://github.com/magento/magento2-page-builder/blob/develop/app/code/Magento/PageBuilder/view/adminhtml/web/template/panel.html.
44+
Within Page Builder, we use this binding for the left panel's content types. You can see the configuration and usage of the `draggable` binding in the Panel component. If you have access to the Page Builder repo, you can find the Panel component template here: https://github.com/magento/magento2-page-builder/blob/develop/app/code/Magento/PageBuilder/view/adminhtml/web/template/panel.html.
4545

4646
**Configuration:**
4747

@@ -83,4 +83,4 @@ The binding has no configuration and must be passed an observable with a boolean
8383

8484
```html
8585
<div data-bind="hasFocusNoScroll: anObservable" />
86-
```
86+
```

docs/release-notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
### Documentation
88

9-
To start learning about Page Builder and Page Builder development:
9+
To learn more about Page Builder and Page Builder development:
1010

1111
- For developers: [What is Page Builder?](https://devdocs.magento.com/page-builder/docs/index.html)
1212
- For end-users: [Page Builder User Guide](https://docs.magento.com/m2/ee/user_guide/cms/page-builder.html)

0 commit comments

Comments
 (0)