Skip to content

Commit b0a25e7

Browse files
Merge pull request #541 from pottink/fix-documentation-typos
Update documentation typo and workflow
2 parents 97df5d2 + f541718 commit b0a25e7

File tree

3 files changed

+16
-10
lines changed

3 files changed

+16
-10
lines changed
Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
# Workflow tips
22

3-
When you are working on a page and changing the master.html template, you need to Save the page in the Admin UI and make some kind of change to the preview template on the Admin UI. Otherwise, you will not see your changes in the browser. This is due to how Page Builder updates changes: it will not update the master template until changes have been made to the page.
3+
## Save page
4+
5+
When you are working on a page and changing the master.html template, you need to Save the page in the Admin UI and make some kind of change to the preview template on the Admin UI. Otherwise, you will not see your changes in the browser. This is due to how Page Builder updates changes: it will not update the master template until changes have been made to the page.
6+
7+
## Setup and cache
8+
9+
If you change something in the configuration of your extension and the change is not visible, run `bin/magento cache:flush` to ensure that the configuration is updated.
410

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Your file structure for the Banner extension form and corresponding layout shoul
1212

1313
### Extension form
1414

15-
When customizing an existing form, make sure you name your form with the same name as the existing content type's form. In our case, we are customizing the Banner's form, which means we must name our form: `pagebuilder-banner-form.xml`. Here's the basic XML configuration for the Banner form extension:
15+
When customizing an existing form, make sure you name your form with the same name as the existing content type's form. In our case, we are customizing the Banner's form, which means we must name our form: `pagebuilder_banner_form.xml`. Here's the basic XML configuration for the Banner form extension:
1616

1717
```xml
1818
<?xml version="1.0" encoding="UTF-8"?>
@@ -46,7 +46,7 @@ When customizing an existing form, make sure you name your form with the same na
4646
</dataProvider>
4747
</dataSource>
4848

49-
<!--Add Fieldsets and fields-->
49+
<!--Add Fieldsets and fields-->
5050

5151
</form>
5252
```
@@ -93,7 +93,7 @@ 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`, run `bin/magento cache:clean`, 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

docs/getting-started/install-pagebuilder-examples.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ You can find the Page Builder examples used in this documentation on GitHub in t
88

99
## Custom content type modules
1010

11-
The [Example directory](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/Example) on the repo provides custom content-type modules for you to download and install. The Page Builder team members created these modules to serve as examples for learning. They are not fully tested or guaranteed to work perfectly. However, we will do our best to improve these examples and keep them updated with the latest releases of Page Builder.
11+
The [Example directory](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/Example) on the repo provides custom content-type modules for you to download and install. The Page Builder team members created these modules to serve as examples for learning. They are not fully tested or guaranteed to work perfectly. However, we will do our best to improve these examples and keep them updated with the latest releases of Page Builder.
1212

1313
- **[PageBuilderQuote](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/Example/PageBuilderQuote)** — Create by [Bruce Denham](https://github.com/bdenham). This module shows you how to create a content type for a customer testimonial page. This is the completed Quote module featured in the [Create a content type tutorial](../create-custom-content-type/overview.md).
1414
- **[PageBuilderGrid](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/Example/PageBuilderGrid)** — Created by [Dave Macaulay](https://github.com/davemacaulay). This module shows you how to create a content type that recreates the layout of the Magento Luma-themed home page using a grid structure with grid items.
@@ -47,22 +47,22 @@ Assuming you have Page Builder already installed, you can install the example mo
4747
2. Navigate to your `<Magento2_installation>/app/code/` directory.
4848
4949
3. Copy or symlink the `Example` directory from your local `pagebuilder-examples` clone into your `app/code/` directory.
50-
50+
5151
**To Symlink**:
5252
```terminal
5353
ln -s <Relative_route_to_cloned_Example_directory>
5454
```
55-
55+
5656
![Examples installation directory](../images/examples-install-location.png)
57-
57+
5858
4. Enable the modules using the `setup:upgrade` command:
5959
6060
```terminal
6161
bin/magento setup:upgrade
6262
```
63-
63+
6464
5. Navigate to a Page Builder instance to ensure the example content types appear in the Page Builder panel, as shown here:
6565

6666
![Content type examples shown in panel](../images/example-content-types.png)
6767

68-
68+

0 commit comments

Comments
 (0)