Skip to content

Commit 16c79db

Browse files
committed
MC-5769: Complete content type tutorial
Syncing link fixes with devdocs_internal
1 parent d00f899 commit 16c79db

File tree

9 files changed

+22
-30
lines changed

9 files changed

+22
-30
lines changed

docs/configurations/panel-configurations.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,6 @@ These groups are defined in the Page Builder `group.xml` file and can be extende
1717
## Overview
1818

1919
This topic describes four ways to customize the Page Builder panel:
20-
21-
- [Panel groups and configurations](#panel-groups-and-configurations)
22-
- [Overview](#overview)
2320
- [Rename panel groups](#rename-panel-groups)
2421
- [Reorder panel groups](#reorder-panel-groups)
2522
- [Add new panel groups](#add-new-panel-groups)

docs/create-basic-content-type/step-2-add-templates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Content types cannot be rendered without these templates. Add them to your modul
5555

5656
![Admin preview.html template](../images/drag-content-type-to-stage.png)
5757

58-
Notice that you also have an options menu when you hover over your content type. This is provided by including the `<render args="getOptions().template" />` within your `preview.html` template. See [Option menu configurations](option-menu-configurations.md) for more details.
58+
Notice that you also have an options menu when you hover over your content type. This is provided by including the `<render args="getOptions().template" />` within your `preview.html` template. See [Option menu configurations](../configurations/option-menu-configurations.md) for more details.
5959

6060
## Create the `master_template`
6161

docs/how-to/how-to-add-custom-toolbar.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ To add a custom toolbar to a Page Builder content block:
1313
1. [Add a toolbar configuration](#toolbarConfig)
1414
2. [Add a toolbar template](#toolbarTpl)
1515

16-
## Add a toolbar configuration
16+
## Add a toolbar configuration {#toolbarConfig}
1717

1818
To add a Toolbar configuration to your content block, you need to create a new instance of the `Toolbar` class, then add configuration options to it.
1919

@@ -63,7 +63,7 @@ Option property descriptions:
6363
| `label` | Label of the option. If no icon is specified, this will be displayed |
6464
| `icon` | Name of CSS class to use for the icon. |
6565

66-
## Add toolbar template
66+
## Add toolbar template {#toolbarTpl}
6767

6868
In your content block template, add the toolbar events to your main toolbar container, and insert the toolbar template:
6969

docs/how-to/how-to-develop-container-content-type.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Each container group has 3 containers in a grid and styled differently based on
99

1010
## Before you begin
1111

12-
For creating a generic content type and content type collection, see [How to add a new content type][].
12+
For creating a generic content type and content type collection, see [How to develop a new content type][].
1313

1414
Make sure you know how to register your custom module.
1515
See [Register your component](https://devdocs.magento.com/guides/v2.2/extension-dev-guide/build/component-registration.html) in devdocs.
@@ -1027,7 +1027,7 @@ Use the configuration form in the container group's edit panel to switch between
10271027

10281028
![Custom Containers Form](../images/custom-containers-form.png)
10291029

1030-
[How to add a new content type]: how-to-add-new-content-type.md
1030+
[How to develop a new content type]: how-to-develop-new-content-type.md
10311031
[Register your component]: https://devdocs.magento.com/guides/v2.2/extension-dev-guide/build/component-registration.html
10321032
[custom container]: #custom-container
10331033
[custom container group]: #custom-container-group

docs/how-to/how-to-use-image-uploader.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,11 @@ This topic describes how to add a reusable image uploader component to the PageB
77
## Overview
88

99
To add image uploader customization to PageBuilder:
10-
11-
- [How to use the Image Uploader](#how-to-use-the-image-uploader)
12-
- [What's in this topic](#whats-in-this-topic)
13-
- [Overview](#overview)
1410
- [Add configuration for the uploader](#add-configuration-for-the-uploader)
15-
- [Update the `<YourModule>/view/adminhtml/web/js/content-type/<content_type_name>/preview.js` file {#js-file}](#update-the-yourmoduleviewadminhtmlwebjscontent-typecontenttypenamepreviewjs-file-js-file)
16-
- [Update the preview template to display the uploader component {#preview}](#update-the-preview-template-to-display-the-uploader-component-preview)
11+
- [Update the `<YourModule>/view/adminhtml/web/js/content-type/<content_type_name>/preview.js` file {#js-file}](#js-file)
12+
- [Update the preview template to display the uploader component {#preview}](#preview)
1713

18-
## Add configuration for the uploader
14+
## Add configuration for the uploader {#add-configuration-for-the-uploader}
1915

2016
Use `additional_data` in your `<YourModule>/view/base/pagebuilder/content_type/<content-type-name>.xml` XML config file to add the image uploader custom configuration to a content type:
2117

docs/migration/migrate-custom-content-types-from-bluefoot.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,8 +185,8 @@ Run the following command on the server to initiate your module's migration proc
185185

186186
You have migrated your old BlueFoot content type into your new PageBuilder content type!
187187

188-
[PageBuilder migration API]: bluefoot-data-migration.md
189-
[BlueFoot data migration]: bluefoot-data-migration.md
188+
[PageBuilder migration API]: migrate-from-bluefoot.md
189+
[BlueFoot data migration]: migrate-from-bluefoot.md
190190
[`composer.json`]: https://devdocs.magento.com/guides/v2.2/extension-dev-guide/build/composer-integration.html
191191
[versioning policy]: https://devdocs.magento.com/guides/v2.2/extension-dev-guide/versioning/
192192
[module lifecycle]: https://devdocs.magento.com/guides/v2.2/extension-dev-guide/prepare/lifecycle.html

docs/reference/architecture.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ This allows the content to be displayed with minimum changes to the Magento stor
2424
To display Page Builder content on storefront Magento and third party systems need to do the following
2525

2626
Use the following steps to display PageBuilder content on a Magento storefront or third-party system:
27+
2728
<!-- {% raw %} -->
2829
1. Replace all Magento directives such as `{{image url=path/to/image.png}}`
2930
2. Add custom stylesheet to provide the base styles that user can't edit.
@@ -84,13 +85,13 @@ A Mass converter modifies data for all content type elements.
8485
For example, the content type of two elements, main and image has data stored in the fields `border`, `border_color`, `border_width`, `background_image`.
8586
A mass converter allows you to modify all these fields.
8687

87-
For more information, read about how [data is stored internally](#Data store).
88+
For more information, read about how [data is stored internally](#Datastore).
8889

8990
### Element converter
9091

9192
An element converter modifies a single field at a time.
9293

93-
## Data store
94+
## Datastore
9495

9596
Data for content types are stored in a simple object called the DataStore `Magento_PageBuilder/js/data-store`.
9697

@@ -100,7 +101,7 @@ You can use the `subscribe` method to subscribe to changes in the data and perfo
100101

101102
## Content type configuration
102103

103-
Please see [content type configuration](../configurations/content-type-configuration.md#Converter Interfaces) for information on content type configuration.
104+
Please see [content type configuration](../configurations/content-type-configuration.md) for information on content type configuration.
104105

105106
## Appearances
106107

docs/reference/events.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Events
1+
# Events {#events}
22

33
This document contains reference information for events dispatched in Page Builder.
44

@@ -7,9 +7,7 @@ This document contains reference information for events dispatched in Page Build
77

88
## Events list {#eventslist}
99

10-
- [Events](#events)
11-
- [Events list {#eventslist}](#events-list-eventslist)
12-
- [`contentType:*` events](#contenttype-events)
10+
- [`contentType:*` events](#contenttype-events)
1311
- [`contentType:createAfter`](#contenttypecreateafter)
1412
- [`contentType:mountAfter`](#contenttypemountafter)
1513
- [`contentType:dropAfter`](#contenttypedropafter)
@@ -304,7 +302,7 @@ All events starting with `contentType:` can also be called for specific content
304302

305303
[Back to top]
306304

307-
### `image:{{id}}:assignAfter`
305+
### `image:{{id}}:assignAfter` {#imageidassignafter}
308306

309307
**Triggers**
310308

@@ -373,7 +371,7 @@ Function
373371

374372
[Back to top]
375373

376-
### `stage:{{id}}:toggleFullscreen`
374+
### `stage:{{id}}:toggleFullscreen` {#stageidtogglefullscreen}
377375

378376
**Triggers**
379377

@@ -453,14 +451,14 @@ Error
453451

454452
[Back to top]
455453

456-
### `stage:{{id}}:readyAfter`
454+
### `stage:{{id}}:readyAfter` {#stageidreadyafter}
457455

458456
**Triggers**
459457

460458
* `Stage::ready`
461459
* `stage instance`
462460

463-
### `stage:{{id}}:masterFormatRenderAfter`
461+
### `stage:{{id}}:masterFormatRenderAfter` {#stageidmasterformatrenderafter}
464462

465463
**Triggers**
466464

@@ -517,7 +515,7 @@ Error
517515

518516
[Back to top]
519517

520-
### `{{config.name}}:{{id}}:updateAfter`
518+
### `{{config.name}}:{{id}}:updateAfter` {#confignameidupdateafter}
521519

522520
**Triggers**
523521

docs/reference/master-format.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# Master format
2-
32
<!-- {% raw %} -->
43
PageBuilder uses XHTML with inline styles and data attributes as the master format for storage.
54

@@ -25,6 +24,7 @@ Contained:
2524
### main element
2625

2726
Attributes
27+
2828
1. data-enable-parallax [1, 0]
2929
2. data-parallax-speed [0-1]
3030
3. data-background-images `{"desktop_image":"{{media url}}","mobile_image":"{{media url}}"}`

0 commit comments

Comments
 (0)