Skip to content

Commit 4188625

Browse files
bdenhambdenham
committed
MC-5710: Beta docs tutorial
Updated known-issues, installation guide, and added component status
1 parent e43369a commit 4188625

File tree

7 files changed

+123
-198
lines changed

7 files changed

+123
-198
lines changed

‎README.md

Lines changed: 11 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,21 @@
11
# magento2-page-builder
22

3-
<!-- {% raw %} -->
4-
53
## PageBuilder Early Access Program
64

7-
The PageBuilder Early Access Program (EAP) gives partners the following perks:
8-
9-
* Explore PageBuilder extension points to build custom modules and integrations for 3rd party services, such as Facebook, Instagram, etc.
10-
* Try out PageBuilder customization options and extend its functionality beyond its default features.
11-
* Preview PageBuilder to prepare a migration plan from BlueFoot 1.0 to PageBuilder.
12-
13-
**Note:**
14-
*This program should not be used to design and launch a production website using early code.*
5+
The Page Builder Early Access Program (EAP) gives partners the following perks:
6+
7+
* Explore extension points to build custom modules and integrations for 3rd party services, such as Facebook, Instagram, etc.
8+
* Try out customization options and extend its functionality beyond its default features.
9+
* Preview to prepare a migration plan from BlueFoot 1.0 to PageBuilder.
1510

1611
## Installation
1712

18-
We offer one method for installing PageBuilder:
19-
20-
* Using the [GitHub repository] - use this option to install PageBuilder from the GitHub repository and contribute to the code.
21-
22-
[GitHub repository]: docs/install-pagebuilder.md
23-
24-
<!-- {% comment %} -->
13+
See [Install Page Builder](docs/getting-started/install-pagebuilder.md)
2514

2615
## Developer documentation
2716

2817
### Getting Started
2918

30-
* [Introduction](docs/getting-started/introduction.md)
3119
* [Install Page Builder](docs/getting-started/install-pagebuilder.md)
3220
* [Activate Page Builder](docs/getting-started/activate-pagebuilder.md)
3321
* [View Page Builder](docs/getting-started/view-pagebuilder.md)
@@ -80,33 +68,20 @@ We offer one method for installing PageBuilder:
8068

8169
* [Migrate from BlueFoot](docs/migration/migrate-from-bluefoot.md)
8270
* [Migrate custom content types from BlueFoot](docs/migration/migrate-custom-content-types-from-bluefoot.md)
83-
84-
<!-- {% endcomment %} -->
8571

8672
## Contribute to PageBuilder
8773

8874
We appreciate any and all contributions to PageBuilder. If you are interested in contributing to this repository, please see our [Contribution Guide].
8975

90-
[Contribution Guide]: CONTRIBUTING.md
91-
9276
## PageBuilder updates from the Magento core team
9377

94-
The PageBuilder team updates the code every 2 weeks.
95-
**These changes may introduce breaking changes.**
96-
97-
## Provide feedback
78+
We will push new beta releases once a week, including work from the backlog. We don't expect any large breaking changes, but we will communicate them to you if the need arises.
9879

99-
We want to hear what you think of PageBuilder!
100-
We are particularly interested on your thoughts on the following:
80+
## Contact Us
10181

102-
* [How would you customize PageBuilder and what do you need to accomplish this task?](https://github.com/magento/magento2-page-builder/issues/57)
103-
* [What web content API do you use or would like to see in PageBuilder?](https://github.com/magento/magento2-page-builder/issues/58)
82+
To participate in technical discussions and ask questions, join us in [Slack], where a number of Page Builder team members are present.
10483

105-
To participate in technical discussions and ask questions, join us in [Slack].
10684

107-
For all other questions or requests, contact [Olena Tkacheva].
108-
109-
[Slack]: https://magentocommeng.slack.com/
110-
[Olena Tkacheva]: https://magentocommeng.slack.com/messages/@UAFV915FB
85+
[Contribution Guide]: CONTRIBUTING.md
86+
[Slack]: https://magentocommeng.slack.com/messages/GANS1R4C9
11187

112-
<!-- {% endraw %} -->

‎docs/_pagebuilder.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -163,8 +163,8 @@ pages:
163163
url: /page-builder/migration/migrate-custom-content-types-from-bluefoot.html
164164
versionless: true
165165

166-
- label: Contribution guide
167-
url: /page-builder/CONTRIBUTING.html
166+
- label: Component status
167+
url: /page-builder/component-status.html
168168
versionless: true
169169

170170
- label: Roadmap and Known Issues

‎docs/component-status.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
**Last Updated: November 27, 2018**
2+
3+
<style type="text/css" style="display: none">
4+
.status {
5+
padding: 2px;
6+
}
7+
.status.red {
8+
color: #fff;
9+
background-color: #d04437;
10+
}
11+
.status.yellow {
12+
background-color: #f6c342;
13+
}
14+
.status.green {
15+
background-color: #14892c;
16+
color: #fff;
17+
}
18+
</style>
19+
20+
This page shows the status of each content type and component in Page Builder beta as a measure of readiness for each.
21+
22+
Each status color indicates the severity and number of issues for a particular component.
23+
24+
- <span class="status red">Red</span> - The content type or component has critical and blocking issues that make this module unstable.
25+
- <span class="status yellow">Yellow</span> - The content type or component has some issues that may cause problems, but it is still functional.
26+
- <span class="status green">Green</span> - The content type or component has no significant or outstanding issues.
27+
28+
The issues used to generate the status of these components come from verified internal and GitHub reports for Page Builder beta.
29+
Issues that are not related to Page Builder beta are not part of this report.
30+
31+
## Content Types
32+
33+
| Name | Status | Notes |
34+
| ------------------ | ----------------------------------------- | ----------------------------------------- |
35+
| Row | <span class='status green'>Green</span> | |
36+
| Column | <span class='status green'>Green</span> | |
37+
| Tabs | <span class='status green'>Green</span> | |
38+
| Text | <span class='status green'>Green</span> | |
39+
| Heading | <span class='status green'>Green</span> | |
40+
| Buttons | <span class='status green'>Green</span> | |
41+
| Divider | <span class='status green'>Green</span> | |
42+
| HTML Code | <span class='status green'>Green</span> | |
43+
| Image | <span class='status green'>Green</span> | |
44+
| Video | <span class='status green'>Green</span> | |
45+
| Banner | <span class='status green'>Green</span> | |
46+
| Slider | <span class='status yellow'>Yellow</span> | Cannot be edited in IE 11 |
47+
| Map | <span class='status green'>Green</span> | |
48+
| Block | <span class='status green'>Green</span> | |
49+
| Dynamic Block | <span class='status green'>Green</span> | |
50+
| Products | <span class='status green'>Green</span> | |
51+
{:style="table-layout:auto"}
52+
53+
## Migration
54+
55+
| Name | Status | Notes |
56+
| --------------------------------- | --------------------------------------- | ----------------------|
57+
| Bluefoot to Page Builder | <span class='status red'>Red</span> | The renderers provided out of the box are not fully updated with the latest changes to their respective content types.|
58+
{:style="table-layout:auto"}

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

Lines changed: 21 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,43 @@
11
# Install Page Builder
22

3-
<!-- {% raw %} -->
3+
## Prerequisites
44

5-
## Overview
5+
You must be an active member in the Page Builder EAP program and have submitted your MAGEID to be provided access to the Page Builder composer packages through `repo.magento.com`. If you have not done so, or are experiencing problems please contact us at `pagebuilderEAP@adobe.com`.
66

7-
Follow these steps to install Page Builder.
7+
## Installation Steps
88

9-
### Prerequisites
9+
1. Upgrade an existing project to Magento 2.3.0 Commerce or install a fresh copy. Instructions for installation can be found [here](https://devdocs.magento.com/guides/v2.3/install-gde/bk-install-guide.html). **Use the MAGEID assigned to you when you signed up to the program.**
1010

11-
* You submitted your MAGEID and github username and received access to 2.3 alpha and PageBuilder 100.0.0 alpha.
12-
If you didn't submit this information, send us an email to request access.
13-
14-
### Steps
15-
16-
1. If you already have 2.3.0 alpha or Page Builder 100.0.0 alpha version installed, run the following command before installing again:
17-
``` sh
18-
composer clearcache
19-
```
20-
If you don’t clear the cache, Composer will not download the latest alpha release from the repo and will use the local, cached packages instead.
21-
2. Navigate to the directory where you want to install Magento and Page Builder.
22-
3. Install the 2.3.0 alpha Commerce package using the following command:
23-
``` sh
24-
composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition:^2.3.0-alpha72
11+
2. Navigate to the root of the project and require the `magento/module-page-builder-commerce` package:
2512
```
26-
27-
Enter the access keys for your account (Marketplace / My Profile / Access Keys)
28-
4. Clone Page Builder repos
29-
``` sh
30-
git clone https://github.com/magento/magento2-page-builder
31-
git clone https://github.com/magento/magento2-page-builder-ee
32-
```
33-
5. Copy dev and app directories in magento2-page-builder and magento2-page-builder-ee to the directory with Magento Commerce 2.3 alpha
34-
``` sh
35-
cp -r magento2-page-builder/app project-enterprise-edition/
36-
cp -r magento2-page-builder/dev project-enterprise-edition/
37-
cp -r magento2-page-builder-ee/app project-enterprise-edition/
38-
cp -r magento2-page-builder-ee/dev project-enterprise-edition/
13+
composer require magento/page-builder-commerce
3914
```
40-
6. Enable Page Builder module using the following command:
15+
16+
3. Enable the module within Magento:
4117
``` sh
4218
bin/magento setup:upgrade
4319
```
20+
21+
{: .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:
4423
45-
## Update steps
46-
47-
When a new version of Page Builder is available, destroy your existing 2.3.0-alpha instance and follow the [composer](install-pagebuilder.md#composer-installation) or [GitHub](install-pagebuilder.md#github-installation) installation steps.
24+
```sh
25+
composer clearcache
26+
```
4827

49-
## Troubleshooting
28+
## Updating
5029

51-
### Page Builder repositories access problems
30+
We plan to release a new version of Page Builder beta every week.
31+
This can be install by completing a `composer update` within your project.
5232

53-
If you are having trouble accessing PageBuilder repositories, please contact Olena Tkacheva.
33+
## Troubleshooting
5434

55-
### 2.3 alpha installation problems
35+
### Composer Installation issues
5636

57-
If you run into any of the following errors:
58-
59-
```shell
60-
Could not find package magento/project-enterprise-edition with version 2.3.0-alpha.
61-
```
37+
If you run into the following issue:
6238

6339
```shell
6440
Could not find a matching version of package magento/module-page-builder-commerce. Check the package spelling, your version constraint and that the package is available in a stability which matches your minimum-stability (stable).
6541
```
6642

67-
Check your composer keys in the `auth.json` file.
68-
If these keys are correct and you still encounter these errors, please contact Olena Tkacheva.
69-
70-
71-
<!-- {% endraw %} -->
43+
Please ensure the credentials you're using to connect with `repo.magento.com` belong to the MAGEID you provided when you signed up to the EAP program.

‎docs/getting-started/introduction.md

Lines changed: 12 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,21 @@
1-
<!-- {% raw %} -->
2-
3-
# Introduction
4-
5-
PageBuilder is a module that provides a visual way to build content within the Admin editor for Magento 2.3 and above.
6-
It replaces the default WYSIWYG Editor in the Admin area with a highly configurable drag-and-drop editing system.
7-
81
## PageBuilder Early Access Program
92

10-
The PageBuilder Early Access Program (EAP) gives partners the following perks:
11-
12-
* Explore PageBuilder extension points to build custom modules and integrations for 3rd party services, such as Facebook, Instagram, etc.
13-
* Try out PageBuilder customization options and extend its functionality beyond its default features.
14-
* Preview PageBuilder to prepare a migration plan from BlueFoot 1.0 to PageBuilder.
15-
16-
**Note:**
17-
*This program should not be used to design and launch a production website using early code.*
3+
The Page Builder Early Access Program (EAP) gives partners the following perks:
4+
5+
* Explore extension points to build custom modules and integrations for 3rd party services, such as Facebook and Instagram.
6+
* Try out customization options and extend its functionality beyond its default features.
7+
* Preview to prepare a migration plan from BlueFoot 1.0 to PageBuilder.
188

199
## Installation
2010

21-
To install Page Builder, use the method described in the topic [Install Page Builder].
22-
23-
[Install Page Builder]: install-pagebuilder.md
11+
See [Install Page Builder](docs/getting-started/install-pagebuilder.md)
2412

2513
<!-- {% comment %} -->
2614

2715
## Developer documentation
2816

2917
### Getting Started
3018

31-
* [Introduction](../getting-started/introduction.md)
3219
* [Install Page Builder](../getting-started/install-pagebuilder.md)
3320
* [Activate Page Builder](../getting-started/activate-pagebuilder.md)
3421
* [View Page Builder](../getting-started/view-pagebuilder.md)
@@ -81,32 +68,21 @@ To install Page Builder, use the method described in the topic [Install Page Bui
8168

8269
* [Migrate from BlueFoot](../migration/migrate-from-bluefoot.md)
8370
* [Migrate custom content types from BlueFoot](../migration/migrate-custom-content-types-from-bluefoot.md)
84-
71+
8572
<!-- {% endcomment %} -->
8673

8774
## Contribute to PageBuilder
8875

8976
We appreciate any and all contributions to PageBuilder. If you are interested in contributing to this repository, please see our [Contribution Guide].
9077

91-
[Contribution Guide]: CONTRIBUTING.md
92-
9378
## PageBuilder updates from the Magento core team
9479

95-
The PageBuilder team updates the code every 2 weeks.
96-
**These changes may introduce breaking changes.**
97-
98-
## Provide feedback
80+
We will push new beta releases once a week, including work from the backlog. We don't expect any large breaking changes, but we will communicate them to you if the need arises.
9981

100-
We want to hear what you think of PageBuilder!
101-
We are particularly interested on your thoughts on the following:
82+
## Contact Us
10283

103-
* [How would you customize PageBuilder and what do you need to accomplish this task?](https://github.com/magento/magento2-page-builder/issues/57)
104-
* [What web content API do you use or would like to see in PageBuilder?](https://github.com/magento/magento2-page-builder/issues/58)
84+
To participate in technical discussions and ask questions, join us in [Slack], where a number of Page Builder team members are present.
10585

106-
To participate in technical discussions and ask questions, join us in [Slack].
10786

108-
For all other questions or requests, contact Olena Tkacheva or Dave Macaulay.
109-
110-
[Slack]: https://magentocommeng.slack.com/
111-
112-
<!-- {% endraw %} -->
87+
[Contribution Guide]: CONTRIBUTING.md
88+
[Slack]: https://magentocommeng.slack.com/messages/GANS1R4C9

‎docs/known-issues.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Known Issues
2+
3+
This article outlines the known higher priority issues present in the Page Builder beta release. We're actively working on many of these items and will update this document accordingly.
4+
5+
## Issues
6+
7+
* Degraded admin experience in IE 11.
8+
* Unable to edit a slide item due to being unable to click on the edit icon for a slide item. <!-- MC-5443 -->
9+
* Inline editing placeholders behave strangely within the admin and won't disappear when typing starts.
10+
* Product does not display in admin when it is assigned to a specific website. <!-- MC-5373 -->
11+
* TinyMCE inline editing mode is focused after saving a content type within the admin. <!-- MC-3812 -->
12+
* Column rendered widths differ from storefront to admin. <!-- MC-3992 -->
13+
* Issues with paddings, margins, and box-sizing on numerous content types.
14+
* Floating option menus and other controls can be displayed off screen when content types are rendered near the edge of the screen.
15+
* Degraded Parallax performance on storefront and in admin within some browsers. <!-- MC-5480 -->
16+
* Using Page Builder within a slide out form has a degraded experience.
17+
* Left-side panel will not scroll with the user.
18+
* Dragging and dropping can become broken due to another instance of Page Builder being loaded.
19+
* Scrolling within full-screen mode can cause the underlying page to scroll instead of the Page Builder content.

0 commit comments

Comments
 (0)