Skip to content

Commit 7a6e848

Browse files
committed
MC-5710: Beta docs tutorial
Added disclaimers for tutorial that is currently in progress.
1 parent ff20854 commit 7a6e848

File tree

10 files changed

+28
-11
lines changed

10 files changed

+28
-11
lines changed

docs/create-basic-content-type/overview.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Overview
22

3+
{: .bs-callout .bs-callout-info }
4+
The development of this tutorial is currently **IN PROGRESS**.
5+
36
Out of the box, Page Builder comes with several content types (controls) that you can drag onto the stage to build your storefront pages, as shown below. In this topic, you will learn how to create your own content type for use within Page Builder.
47

58
![Page Builder Content Types](../images/panel-horizontal.png)

docs/create-basic-content-type/step-1-add-configuration.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
# Step 1: Add configuration
44

5+
{: .bs-callout .bs-callout-info }
6+
The development of this tutorial is currently **IN PROGRESS**.
7+
58
The configuration file gives your content type its existence. It's where you set the name, display label, and references to the other files that define the appearance and behavior of your content type. Add it to your module here (`view/adminhtml/pagebuilder/content_type/`):
69

710
![Create config file](../images/step1-add-config-file.png)

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
# Step 2: Add templates
44

5+
{: .bs-callout .bs-callout-info }
6+
The development of this tutorial is currently **IN PROGRESS**.
7+
58
Templates are the HTML files that define the appearance of content types within both the Admin UI (using the `preview.html`) and the storefront UI (using the `master.html`).
69

710
## Configuration

docs/create-basic-content-type/step-3-add-components.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
# Step 3: Add components (optional)
44

5+
{: .bs-callout .bs-callout-info }
6+
The development of this tutorial is currently **IN PROGRESS**.
7+
58
Components are the JavaScript files that define the behaviors of your content type when they appear on the stage in the Admin UI (using the `preview.js` component) and in the storefront (using the `master.js` component). As such, they are complementary to the templates you added previously in Step 2.
69

710
## Configuration

docs/create-basic-content-type/step-4-add-editor.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Step 4: Add editor
22

3+
{: .bs-callout .bs-callout-info }
4+
The development of this tutorial is currently **IN PROGRESS**.
5+
36
Page Builder provides an editor that slides out from the right of the screen within the Admin UI to give users a way to add content and customize the appearance of your content type, as shown in the screen shot. All you have to do is create a UI component form and a layout for the editor to use.
47

58
![Create config file](../images/content-type-editor.png)

docs/create-basic-content-type/step-5-add-styles.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
# Step 5: Add styles
44

5+
{: .bs-callout .bs-callout-info }
6+
The development of this tutorial is currently **IN PROGRESS**.
7+
58
Like in the rest of Magento, you use LESS files to style your content types in the Admin UI and on the storefront (frontend).
69

710
## Configuration

docs/create-basic-content-type/step-6-add-frontend-widget.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
# Step 6: Add frontend widget
44

5+
{: .bs-callout .bs-callout-info }
6+
The development of this tutorial is currently **IN PROGRESS**.
7+
58
The frontend widget is a JavaScript file that controls the UI behavior (user interactivity) of your content type when it is rendered on the storefront.
69

710
## Configuration
Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
<!-- {% raw %} -->
2-
{: .bs-callout .bs-callout-warning }
3-
The development of this tutorial is currently **IN PROGRESS**, **INCOMPLETE**, and potentially **INCORRECT**. The expected completion time is Nov. 27.
4-
51
# What's next?
62

7-
8-
<!-- {% endraw %} -->
3+
{: .bs-callout .bs-callout-info }
4+
The development of this tutorial is currently **IN PROGRESS**.

docs/getting-started/install-pagebuilder.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,7 @@ You must be an active member in the Page Builder EAP program and have submitted
1919
```
2020
2121
{: .bs-callout .bs-callout-info }
22-
If you have had a previous version of Magento 2.3.0 or Page Builder installed you may need to clear your composer cache to ensure the latest packages of both versions are installed:
23-
24-
```sh
25-
composer clearcache
26-
```
22+
If you have had a previous version of Magento 2.3.0 or Page Builder installed you may need to clear your composer cache (`composer clearcache`) to ensure the latest packages of both versions are installed.
2723
2824
## Updating
2925

docs/getting-started/introduction.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,10 @@ See [Install Page Builder](docs/getting-started/install-pagebuilder.md)
6969
* [Migrate from BlueFoot](../migration/migrate-from-bluefoot.md)
7070
* [Migrate custom content types from BlueFoot](../migration/migrate-custom-content-types-from-bluefoot.md)
7171

72+
### Other
73+
74+
* [Component status](../component-status.md)
75+
* [Known issues](../known-issues.md)
7276
<!-- {% endcomment %} -->
7377

7478
## Contribute to PageBuilder

0 commit comments

Comments
 (0)