Skip to content

Commit 45bfba7

Browse files
shrieleneeirenelagno
authored andcommitted
MC-3310: Documentation for MC-1416
1 parent e939ebc commit 45bfba7

26 files changed

+269
-36
lines changed

app/code/Magento/PageBuilder/docs/CONTRIBUTING.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,24 +14,32 @@
1414
6. [How to create custom PageBuilder content type container]
1515

1616
[Introduction]: README.md
17-
[Installation Guide]: install.md
1817
[Contribution guide]: CONTRIBUTING.md
18+
[Installation guide]: install.md
1919
[Developer documentation]: developer-documentation.md
2020
[Architecture overview]: architecture-overview.md
2121
[BlueFoot to PageBuilder data migration]: bluefoot-data-migration.md
2222
[Third-party content type migration]: new-content-type-example.md
2323
[Iconography]: iconography.md
24+
[Add image uploader to content type]: image-uploader.md
2425
[Module integration]: module-integration.md
2526
[Additional data configuration]: custom-configuration.md
2627
[Content type configuration]: content-type-configuration.md
2728
[How to add a new content type]: how-to-add-new-content-type.md
2829
[Events]: events.md
30+
[Bindings]: bindings.md
2931
[Master format]: master-format.md
3032
[Visual select]: visual-select.md
3133
[Reuse product conditions in content types]: product-conditions.md
3234
[Store component master format as widget directive]: widget-directive.md
35+
[Use the block chooser UI component]: block-chooser-component.md
36+
[Use the inline text editing component]: inline-editing-component.md
37+
[Render a backend content type preview]: content-type-preview.md
3338
[Custom Toolbar]: toolbar.md
34-
[Roadmap and Known Issues]: roadmap.m
39+
[Full width page layouts]: full-width-page-layouts.md
40+
[Add image uploader to content type]: image-uploader.md
41+
[Roadmap and Known Issues]: roadmap.md
42+
[How to create custom PageBuilder content type container]: how-to-create-custom-content-type-container.md
3543

3644
## Overview
3745

app/code/Magento/PageBuilder/docs/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ It replaces the default WYSIWYG Editor in the Admin area with a highly configura
2525
1. [Reuse product conditions in content types]
2626
1. [Store component master format as widget directive]
2727
1. [Use the block chooser UI component]
28+
1. [Use the inline text editing component]
2829
1. [Render a backend content type preview]
2930
1. [Custom Toolbar]
3031
1. [Full width page layouts]
@@ -50,8 +51,9 @@ It replaces the default WYSIWYG Editor in the Admin area with a highly configura
5051
[Visual select]: visual-select.md
5152
[Reuse product conditions in content types]: product-conditions.md
5253
[Store component master format as widget directive]: widget-directive.md
53-
[Render a backend content type preview]: content-type-preview.md
5454
[Use the block chooser UI component]: block-chooser-component.md
55+
[Use the inline text editing component]: inline-editing-component.md
56+
[Render a backend content type preview]: content-type-preview.md
5557
[Custom Toolbar]: toolbar.md
5658
[Full width page layouts]: full-width-page-layouts.md
5759
[Add image uploader to content type]: image-uploader.md

app/code/Magento/PageBuilder/docs/architecture-overview.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
1. [Reuse product conditions in content types]
2323
1. [Store component master format as widget directive]
2424
1. [Use the block chooser UI component]
25+
1. [Use the inline text editing component]
2526
1. [Render a backend content type preview]
2627
1. [Custom Toolbar]
2728
1. [Full width page layouts]
@@ -47,14 +48,16 @@
4748
[Visual select]: visual-select.md
4849
[Reuse product conditions in content types]: product-conditions.md
4950
[Store component master format as widget directive]: widget-directive.md
50-
[Render a backend content type preview]: content-type-preview.md
5151
[Use the block chooser UI component]: block-chooser-component.md
52+
[Use the inline text editing component]: inline-editing-component.md
53+
[Render a backend content type preview]: content-type-preview.md
5254
[Custom Toolbar]: toolbar.md
5355
[Full width page layouts]: full-width-page-layouts.md
5456
[Add image uploader to content type]: image-uploader.md
5557
[Roadmap and Known Issues]: roadmap.md
5658
[How to create custom PageBuilder content type container]: how-to-create-custom-content-type-container.md
5759

60+
5861
## What is PageBuilder?
5962

6063
PageBuilder is tool that simplifies content creation by letting you drag and drop content types and configure them without writing a line of code.

app/code/Magento/PageBuilder/docs/bindings.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
1. [Reuse product conditions in content types]
2323
1. [Store component master format as widget directive]
2424
1. [Use the block chooser UI component]
25+
1. [Use the inline text editing component]
2526
1. [Render a backend content type preview]
2627
1. [Custom Toolbar]
2728
1. [Full width page layouts]
@@ -47,14 +48,16 @@
4748
[Visual select]: visual-select.md
4849
[Reuse product conditions in content types]: product-conditions.md
4950
[Store component master format as widget directive]: widget-directive.md
50-
[Render a backend content type preview]: content-type-preview.md
5151
[Use the block chooser UI component]: block-chooser-component.md
52+
[Use the inline text editing component]: inline-editing-component.md
53+
[Render a backend content type preview]: content-type-preview.md
5254
[Custom Toolbar]: toolbar.md
5355
[Full width page layouts]: full-width-page-layouts.md
5456
[Add image uploader to content type]: image-uploader.md
5557
[Roadmap and Known Issues]: roadmap.md
5658
[How to create custom PageBuilder content type container]: how-to-create-custom-content-type-container.md
5759

60+
5861
## Summary
5962

6063
As part of the Page Builder application, we provide new Knockout bindings you can use in your custom content types:

app/code/Magento/PageBuilder/docs/block-chooser-component.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,12 @@
2222
1. [Reuse product conditions in content types]
2323
1. [Store component master format as widget directive]
2424
1. **Use the block chooser UI component**
25+
1. [Use the inline text editing component]
2526
1. [Render a backend content type preview]
2627
1. [Custom Toolbar]
2728
1. [Full width page layouts]
2829
5. [Roadmap and known issues]
29-
6. [How to create custom PageBuilder content type container]
30+
6. [How to create custom PageBuilder content type container
3031

3132
[Introduction]: README.md
3233
[Contribution guide]: CONTRIBUTING.md
@@ -47,14 +48,16 @@
4748
[Visual select]: visual-select.md
4849
[Reuse product conditions in content types]: product-conditions.md
4950
[Store component master format as widget directive]: widget-directive.md
50-
[Render a backend content type preview]: content-type-preview.md
5151
[Use the block chooser UI component]: block-chooser-component.md
52+
[Use the inline text editing component]: inline-editing-component.md
53+
[Render a backend content type preview]: content-type-preview.md
5254
[Custom Toolbar]: toolbar.md
5355
[Full width page layouts]: full-width-page-layouts.md
5456
[Add image uploader to content type]: image-uploader.md
5557
[Roadmap and Known Issues]: roadmap.md
5658
[How to create custom PageBuilder content type container]: how-to-create-custom-content-type-container.md
5759

60+
5861
## What's in this topic
5962

6063
This topic describes how to use the block chooser UI component for a custom content type.

app/code/Magento/PageBuilder/docs/bluefoot-data-migration.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# BlueFoot to PageBuilder data migration
2+
23
## Navigation
34

45
1. [Introduction]
@@ -14,24 +15,23 @@
1415
1. [Additional data configuration]
1516
1. [Content type configuration]
1617
1. [How to add a new content type]
17-
1. [Bindings]
1818
1. [Events]
1919
1. [Bindings]
2020
1. [Master format]
2121
1. [Visual select]
2222
1. [Reuse product conditions in content types]
2323
1. [Store component master format as widget directive]
2424
1. [Use the block chooser UI component]
25+
1. [Use the inline text editing component]
2526
1. [Render a backend content type preview]
2627
1. [Custom Toolbar]
27-
1. [Add image uploader to content type]
2828
1. [Full width page layouts]
2929
5. [Roadmap and known issues]
3030
6. [How to create custom PageBuilder content type container]
3131

3232
[Introduction]: README.md
33-
[Installation Guide]: install.md
3433
[Contribution guide]: CONTRIBUTING.md
34+
[Installation guide]: install.md
3535
[Developer documentation]: developer-documentation.md
3636
[Architecture overview]: architecture-overview.md
3737
[BlueFoot to PageBuilder data migration]: bluefoot-data-migration.md
@@ -42,21 +42,22 @@
4242
[Additional data configuration]: custom-configuration.md
4343
[Content type configuration]: content-type-configuration.md
4444
[How to add a new content type]: how-to-add-new-content-type.md
45-
[Bindings]: bindings.md
4645
[Events]: events.md
4746
[Bindings]: bindings.md
4847
[Master format]: master-format.md
4948
[Visual select]: visual-select.md
5049
[Reuse product conditions in content types]: product-conditions.md
5150
[Store component master format as widget directive]: widget-directive.md
52-
[Render a backend content type preview]: content-type-preview.md
5351
[Use the block chooser UI component]: block-chooser-component.md
52+
[Use the inline text editing component]: inline-editing-component.md
53+
[Render a backend content type preview]: content-type-preview.md
5454
[Custom Toolbar]: toolbar.md
5555
[Full width page layouts]: full-width-page-layouts.md
5656
[Add image uploader to content type]: image-uploader.md
5757
[Roadmap and Known Issues]: roadmap.md
5858
[How to create custom PageBuilder content type container]: how-to-create-custom-content-type-container.md
5959

60+
6061
## Overview
6162

6263
This topic goes over the data migration process for BlueFoot data into the PageBuilder module in Magento 2.3.

app/code/Magento/PageBuilder/docs/content-type-configuration.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
1. [Reuse product conditions in content types]
2626
1. [Store component master format as widget directive]
2727
1. [Use the block chooser UI component]
28+
1. [Use the inline text editing component]
2829
1. [Render a backend content type preview]
2930
1. [Custom Toolbar]
3031
1. [Full width page layouts]
@@ -50,14 +51,16 @@
5051
[Visual select]: visual-select.md
5152
[Reuse product conditions in content types]: product-conditions.md
5253
[Store component master format as widget directive]: widget-directive.md
53-
[Render a backend content type preview]: content-type-preview.md
5454
[Use the block chooser UI component]: block-chooser-component.md
55+
[Use the inline text editing component]: inline-editing-component.md
56+
[Render a backend content type preview]: content-type-preview.md
5557
[Custom Toolbar]: toolbar.md
5658
[Full width page layouts]: full-width-page-layouts.md
5759
[Add image uploader to content type]: image-uploader.md
5860
[Roadmap and Known Issues]: roadmap.md
5961
[How to create custom PageBuilder content type container]: how-to-create-custom-content-type-container.md
6062

63+
6164
## Configuration
6265

6366
Use the content type and group configuration to add new content types, extend existing content types, add groups in the left menu, or rearrange content types in the groups.

app/code/Magento/PageBuilder/docs/content-type-preview.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,22 @@
1010
1. [BlueFoot to PageBuilder data migration]
1111
1. [Third-party content type migration]
1212
1. [Iconography]
13+
1. [Add image uploader to content type]
1314
1. [Module integration]
1415
1. [Additional data configuration]
1516
1. [Content type configuration]
1617
1. [How to add a new content type]
1718
1. [Events]
19+
1. [Bindings]
1820
1. [Master format]
19-
1. [Visual select]
21+
1. [Visual select]
2022
1. [Reuse product conditions in content types]
2123
1. [Store component master format as widget directive]
24+
1. [Use the block chooser UI component]
25+
1. [Use the inline text editing component]
2226
1. **Render a backend content type preview**
2327
1. [Custom Toolbar]
28+
1. [Full width page layouts]
2429
5. [Roadmap and known issues]
2530
6. [How to create custom PageBuilder content type container]
2631

@@ -32,21 +37,27 @@
3237
[BlueFoot to PageBuilder data migration]: bluefoot-data-migration.md
3338
[Third-party content type migration]: new-content-type-example.md
3439
[Iconography]: iconography.md
40+
[Add image uploader to content type]: image-uploader.md
3541
[Module integration]: module-integration.md
3642
[Additional data configuration]: custom-configuration.md
3743
[Content type configuration]: content-type-configuration.md
3844
[How to add a new content type]: how-to-add-new-content-type.md
39-
[content type]: how-to-add-new-content-type.md
4045
[Events]: events.md
46+
[Bindings]: bindings.md
4147
[Master format]: master-format.md
4248
[Visual select]: visual-select.md
4349
[Reuse product conditions in content types]: product-conditions.md
4450
[Store component master format as widget directive]: widget-directive.md
51+
[Use the block chooser UI component]: block-chooser-component.md
52+
[Use the inline text editing component]: inline-editing-component.md
4553
[Render a backend content type preview]: content-type-preview.md
4654
[Custom Toolbar]: toolbar.md
55+
[Full width page layouts]: full-width-page-layouts.md
56+
[Add image uploader to content type]: image-uploader.md
4757
[Roadmap and Known Issues]: roadmap.md
4858
[How to create custom PageBuilder content type container]: how-to-create-custom-content-type-container.md
4959

60+
5061
## What's in this topic
5162
This topic describes how to use the `RenderPool` on the stage to render a backend [content type] preview.
5263

app/code/Magento/PageBuilder/docs/custom-configuration.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,23 @@
1515
1. **Additional data configuration**
1616
1. [Content type configuration]
1717
1. [How to add a new content type]
18-
1. [Bindings]
1918
1. [Events]
2019
1. [Bindings]
2120
1. [Master format]
2221
1. [Visual select]
2322
1. [Reuse product conditions in content types]
2423
1. [Store component master format as widget directive]
2524
1. [Use the block chooser UI component]
25+
1. [Use the inline text editing component]
2626
1. [Render a backend content type preview]
2727
1. [Custom Toolbar]
28-
1. [Add image uploader to content type]
2928
1. [Full width page layouts]
3029
5. [Roadmap and known issues]
3130
6. [How to create custom PageBuilder content type container]
3231

3332
[Introduction]: README.md
34-
[Installation Guide]: install.md
3533
[Contribution guide]: CONTRIBUTING.md
34+
[Installation guide]: install.md
3635
[Developer documentation]: developer-documentation.md
3736
[Architecture overview]: architecture-overview.md
3837
[BlueFoot to PageBuilder data migration]: bluefoot-data-migration.md
@@ -43,15 +42,15 @@
4342
[Additional data configuration]: custom-configuration.md
4443
[Content type configuration]: content-type-configuration.md
4544
[How to add a new content type]: how-to-add-new-content-type.md
46-
[Bindings]: bindings.md
4745
[Events]: events.md
4846
[Bindings]: bindings.md
4947
[Master format]: master-format.md
5048
[Visual select]: visual-select.md
5149
[Reuse product conditions in content types]: product-conditions.md
5250
[Store component master format as widget directive]: widget-directive.md
53-
[Render a backend content type preview]: content-type-preview.md
5451
[Use the block chooser UI component]: block-chooser-component.md
52+
[Use the inline text editing component]: inline-editing-component.md
53+
[Render a backend content type preview]: content-type-preview.md
5554
[Custom Toolbar]: toolbar.md
5655
[Full width page layouts]: full-width-page-layouts.md
5756
[Add image uploader to content type]: image-uploader.md

app/code/Magento/PageBuilder/docs/developer-documentation.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
1. [Reuse product conditions in content types]
2323
1. [Store component master format as widget directive]
2424
1. [Use the block chooser UI component]
25+
1. [Use the inline text editing component]
2526
1. [Render a backend content type preview]
2627
1. [Custom Toolbar]
2728
1. [Full width page layouts]
@@ -62,6 +63,8 @@
6263

6364
**[Use the block chooser UI component]** - Documentation on using the block chooser UI component for a custom content type.
6465

66+
**[Use the inline text editing component]** - Documentation on adding a reusable inline text editing component to the PageBuilder stage for a content type.
67+
6568
**[Render a backend content type preview]** - Documentation on using the `RenderPool` on the stage to render a content type preview.
6669

6770
**[Custom Toolbar]** - Documentation on adding a custom toolbar.
@@ -89,6 +92,7 @@
8992
[Store component master format as widget directive]: widget-directive.md
9093
[Render a backend content type preview]: content-type-preview.md
9194
[Use the block chooser UI component]: block-chooser-component.md
95+
[Use the inline text editing component]: inline-editing-component.md
9296
[Custom Toolbar]: toolbar.md
9397
[Full width page layouts]: full-width-page-layouts.md
9498
[Add image uploader to content type]: image-uploader.md

0 commit comments

Comments
 (0)