Skip to content

Commit a368c69

Browse files
committed
MC-4181: Organize Existing Topics
Making changes based on PR review
1 parent 3495f2a commit a368c69

14 files changed

+50
-51
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,40 +32,40 @@ We offer two methods for installing PageBuilder:
3232
1. [Introduction](docs/getting-started/introduction.md)
3333
2. [Install Page Builder](docs/getting-started/install-pagebuilder.md)
3434
3. [Activate Page Builder](docs/getting-started/activate-pagebuilder.md)
35-
4. [Integrate Page Builder](docs/getting-started/integrate-pagebuilder.md)
3635

3736
### Customizations
3837

3938
* [Block chooser](docs/customizations/block-chooser.md)
4039
* [Full-width page layouts](docs/customizations/full-width-page-layouts.md)
4140
* [Responsive layouts](docs/customizations/responsive-layouts.md)
42-
* [Custom logic](docs/customizations/custom-logic.md)
41+
* [Storefront customization](docs/customizations/storefront-customization.md)
4342
* [Visual selects](docs/customizations/visual-selects.md)
44-
* [Data configuration](docs/customizations/data-configuration.md)
43+
* [Additional data configuration](docs/customizations/additional-data-configuration.md)
4544
* [Product conditions](docs/customizations/product-conditions.md)
4645
* [Server-side rendered previews](docs/customizations/server-side-rendered-previews.md)
4746

4847
### How Tos
4948

50-
* [How to add a new content type](docs/how-to/how-to-add-new-content-type.md)
51-
* [How to add an image uploader](docs/how-to/how-to-add-image-uploader.md)
49+
* [How to develop a new content type](docs/how-to/how-to-develop-new-content-type.md)
50+
* [How to develop a container content type](docs/how-to/how-to-develop-container-content-type.md)
51+
* [How to use the Image Uploader](docs/how-to/how-to-use-image-uploader.md)
5252
* [How to add inline text editing](docs/how-to/how-to-add-inline-text-editing.md)
5353
* [How to add a custom toolbar](docs/how-to/how-to-add-custom-toolbar.md)
54-
* [How to create a custom container](docs/how-to/how-to-create-custom-container.md)
54+
* [How to convert product attribute fields to use Page Builder](docs/how-to/how-to-convert-product-attributes-to-use-pagebuilder.md)
5555
* [How to store a component master format as a widget-directive](docs/how-to/how-to-store-master-format-as-widget-directive.md)
5656

5757
### Reference
5858

5959
* [Architecture](docs/reference/architecture.md)
6060
* [Events](docs/reference/events.md)
61-
* [Bindings](docs/reference/bindings.md)
62-
* [Content type configuration](docs/reference/content-type-configuration.md)
61+
* [Knockout bindings](docs/reference/knockout-bindings.md)
62+
* [Configuration](docs/reference/configuration.md)
6363
* [Master format](docs/reference/master-format.md)
6464

6565
### Migration
6666

67-
* [Bluefoot data migration](docs/migration/bluefoot-data-migration.md)
68-
* [Third-party content type migration](docs/migration/third-party-content-type-migration.md)
67+
* [Migrate from BlueFoot](docs/migration/migrate-from-bluefoot.md)
68+
* [Migrate custom content types from BlueFoot](docs/migration/migrate-custom-content-types-from-bluefoot.md)
6969

7070
<!-- {% endcomment %} -->
7171

docs/_pagebuilder.yml

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,6 @@ pages:
1111
- label: Activate Page Builder
1212
url: /page-builder/getting-started/activate-pagebuilder.html
1313
versionless: true
14-
15-
- label: Integrate Page Builder
16-
url: /page-builder/getting-started/integrate-pagebuilder.html
17-
versionless: true
1814

1915
# - label: Developer documentation
2016
# url: /page-builder/developer-documentation.html
@@ -35,16 +31,16 @@ pages:
3531
url: /page-builder/customizations/responsive-layouts.html
3632
versionless: true
3733

38-
- label: Custom logic
39-
url: /page-builder/customizations/custom-logic.html
34+
- label: Storefront customization
35+
url: /page-builder/customizations/storefront-customization.html
4036
versionless: true
4137

4238
- label: Visual selects
4339
url: /page-builder/customizations/visual-selects.html
4440
versionless: true
4541

46-
- label: Data configuration
47-
url: /page-builder/customizations/data-configuration.html
42+
- label: Additional data configuration
43+
url: /page-builder/customizations/additional-data-configuration.html
4844
versionless: true
4945

5046
- label: Product conditions
@@ -58,12 +54,16 @@ pages:
5854
- label: How Tos
5955
versionless: true
6056
children:
61-
- label: How to add a new content type
62-
url: /page-builder/how-to/how-to-add-new-content-type.html
57+
- label: How to develop a new content type
58+
url: /page-builder/how-to/how-to-develop-new-content-type.html
59+
versionless: true
60+
61+
- label: How to develop a container content type
62+
url: /page-builder/how-to/how-to-develop-container-content-type.html
6363
versionless: true
6464

65-
- label: How to add an Image Uploader
66-
url: /page-builder/how-to/how-to-add-image-uploader.html
65+
- label: How to use the Image Uploader
66+
url: /page-builder/how-to/how-to-use-image-uploader.html
6767
versionless: true
6868

6969
- label: How to add inline text editing
@@ -73,9 +73,9 @@ pages:
7373
- label: How to add a custom toolbar
7474
url: /page-builder/how-to/how-to-add-custom-toolbar.html
7575
versionless: true
76-
77-
- label: How to create a custom container
78-
url: /page-builder/how-to/how-to-create-custom-container.html
76+
77+
- label: How to convert product attribute fields to use Page Builder
78+
url: /page-builder/how-to/how-to-convert-product-attributes-to-use-pagebuilder.html
7979
versionless: true
8080

8181
- label: How to store a component's master format as a widget-directive
@@ -97,12 +97,12 @@ pages:
9797
url: /page-builder/reference/events.html
9898
versionless: true
9999

100-
- label: Bindings
101-
url: /page-builder/reference/bindings.html
100+
- label: Knockout bindings
101+
url: /page-builder/reference/knockout-bindings.html
102102
versionless: true
103103

104-
- label: Content type configuration
105-
url: /page-builder/reference/content-type-configuration.html
104+
- label: Configuration
105+
url: /page-builder/reference/configuration.html
106106
versionless: true
107107

108108
- label: Master format
@@ -112,12 +112,12 @@ pages:
112112
- label: Migration to Page Builder
113113
versionless: true
114114
children:
115-
- label: BlueFoot data migration
116-
url: /page-builder/migration/bluefoot-data-migration.html
115+
- label: Migrate from BlueFoot
116+
url: /page-builder/migration/migrate-from-bluefoot.html
117117
versionless: true
118118

119-
- label: Third-party content type migration
120-
url: /page-builder/migration/third-party-content-type-migration.html
119+
- label: Migrate custom content types from BlueFoot
120+
url: /page-builder/migration/migrate-custom-content-types-from-bluefoot.html
121121
versionless: true
122122

123123
- label: Contribution guide

docs/customizations/data-configuration.md renamed to docs/customizations/additional-data-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Data configuration
1+
# Additional data configuration
22

33
<!-- {% raw %} -->
44

docs/customizations/custom-logic.md renamed to docs/customizations/storefront-customization.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Custom logic <!-- omit in toc -->
1+
# Storefront customization <!-- omit in toc -->
22

33
<!-- {% raw %} -->
44
You can customize PageBuilder content types by adding your own logic on the frontend.
55

66
To add custom logic to content types:
77

88
- [Create a JavaScript widget](#create-a-javascript-widget)
9-
- [Add XML configuration to load it on the frontend](#add-xml-configuration-to-load-it-on-the-frontend)
9+
- [Add XML configuration](#add-xml-configuration)
1010

1111
## Create a JavaScript widget
1212

@@ -48,9 +48,9 @@ define([
4848

4949
```
5050

51-
## Add XML configuration to load it on the frontend
51+
## Add XML configuration
5252

53-
Add XML configuration to load it on the frontend, and on the stage, so that you can preview content inside both the block and dynamic block content types.
53+
The XML configuration loads the widget on the frontend, and on the stage, so that you can preview content inside both the block and dynamic block content types.
5454

5555
Add the following configuration to the `etc/di.xml` file in your custom module directory:
5656

docs/getting-started/introduction.md

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

3-
PageBuilder is a Content Management System(CMS) module for Magento 2.3 and above.
3+
PageBuilder is a module that provides a visual way to build content within the Admin editor for Magento 2.3 and above.
44
It replaces the default WYSIWYG Editor in the Admin area with a highly configurable drag-and-drop editing system.
55

6-
This page should serve as a guide to introducing what will be covered in this documentation.
6+
[This page will introduce Page Builder by providing infographics, screenshots, and descriptions for what Page Builder is and how it works.]
77

88
TBW

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44

55
## What's in this topic
66

7-
This document outlines how to add a custom toolbar in Page Builder. It's a simplified/lightweight version of a WYSIWYG:
7+
This document outlines how to implement the inline editing toolbar for any content type. This feature is used within the heading to allow for easy modification of the heading type and alignment. It can be used within your content types to quickly change common things without needing to open the full editor.
8+
89
![Page Builder toolbar](images/toolbar.png)
910

1011
## Overview

docs/getting-started/integrate-pagebuilder.md renamed to docs/how-to/how-to-convert-product-attributes-to-use-pagebuilder.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Integrate Page Builder
1+
# How to convert product attribute fields to use Page Builder
22

33
<!-- {% raw %} -->
44

docs/how-to/how-to-create-custom-container.md renamed to docs/how-to/how-to-develop-container-content-type.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# How to create a custom content type container
1+
# How to develop a container content type
22

33
<!-- {% raw %} -->
44
This tutorial takes you through the process of creating a module with the name `VendorName_CustomContainer`.

docs/how-to/how-to-add-new-content-type.md renamed to docs/how-to/how-to-develop-new-content-type.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# How to add a new content type
1+
# How to develop a new content type
22

33
<!-- {% raw %} -->
44

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# How to add an Image Uploader <!-- omit in toc -->
1+
# How to use the Image Uploader <!-- omit in toc -->
22

33
<!-- {% raw %} -->
44

0 commit comments

Comments
 (0)