Skip to content

Commit ec37482

Browse files
committed
MC-4182: Update Page Builder installation docs for EAP participants
- update documentation
1 parent efcc28a commit ec37482

File tree

3 files changed

+35
-94
lines changed

3 files changed

+35
-94
lines changed
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## Activation
2+
3+
Follow these steps to activate PageBuilder in the Admin:
4+
5+
1. Navigate to the Admin section of you Magento instance.
6+
2. In the **Stores** tab, select **Configuration** under the Settings group.
7+
3. In the **General** group on the page, select **Content Management**.
8+
4. Under **Advanced Content Tools**, select **Yes** for **Enable Page Builder**.
9+
5. Click **Save Config**
10+
11+
## Disable PageBuilder
12+
13+
We recommend you deactivate the PageBuilder editor through the Admin instead of disabling the module itself.
14+
This allows the PageBuilder module to continue rendering the content on the storefront even if the editor is not used in the Admin.
15+
16+
If you disabled or uninstalled the entire PageBuilder module instead of just the editor, you need to do the following to continue using PageBuilder-built content:
17+
18+
1. Implement PageBuilder widgets and initialize them on dynamic blocks since JavaScript functionality provided by PageBuilder will no longer work.
19+
2. Change the layout in the database for entities that use the full width layout to prevent blank layout content.
Binary file not shown.

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

Lines changed: 16 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -23,23 +23,14 @@
2323

2424
## Overview
2525

26-
PageBuilder has two installation paths, one through Composer and the other through GitHub.
27-
28-
If you want to evaluate the PageBuilder module, follow the Composer installation path.
29-
30-
If you want to contribute to the development of PageBuilder, follow the GitHub installation path.
31-
32-
## Composer installation
33-
34-
This installation method uses Composer to install PageBuilder into Magento.
35-
Use this method if you are testing and evaluating PageBuilder for your Magento store.
26+
Follow these steps to install Page Builder.
3627

3728
### Prerequisites
3829

3930
* You submitted your MAGEID and github username and received access to 2.3 alpha and PageBuilder 100.0.0 alpha.
4031
If you didn't submit this information, send us an email to request access.
4132

42-
### Installation steps
33+
### Steps
4334

4435
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:
4536
``` sh
@@ -49,45 +40,23 @@ Use this method if you are testing and evaluating PageBuilder for your Magento s
4940
2. Navigate to the directory where you want to install Magento and Page Builder.
5041
3. Install the 2.3.0 alpha Commerce package using the following command:
5142
``` sh
52-
composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition=2.3.0-alpha
43+
composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition:^2.3.0-alpha72
5344
```
5445

5546
Enter the access keys for your account (Marketplace / My Profile / Access Keys)
56-
4. Install Page Builder
57-
``` sh
58-
composer require magento/module-page-builder-commerce
59-
```
60-
5. Enable Page Builder module using the following command:
61-
``` sh
62-
bin/magento setup:upgrade
63-
```
64-
65-
## GitHub installation
66-
67-
This installation method checks out the PageBuilder repository from GitHub and installs it into a development instance of Magento.
68-
Do not use this installation method for evaluation or production instances.
69-
70-
### Prerequisites
71-
72-
* A local development installation of Magento 2.3.0 alpha
73-
* Access to the PageBuilder repository
74-
* [Yarn package manager]
75-
76-
[Yarn package manager]: https://yarnpkg.com/en/
77-
78-
### Installation steps
79-
80-
1. Navigate to the root directory of your Magento application
81-
2. Clone the PageBuilder repository as a sub-directory using the following command:
47+
4. Clone Page Builder repos
8248
``` sh
83-
git clone git@github.com:magento/magento2-page-builder.git pagebuilder
49+
git clone https://github.com/magento/magento2-page-builder
50+
git clone https://github.com/magento/magento2-page-builder-ee
8451
```
85-
3. Return to the root directory of your Magento application and navigate to `app/code/Magento`
86-
4. In the Magento modules directory, link the PageBuilder module code to the application code using the following command:
52+
5. Copy dev and app directories in magento2-page-builder and magento2-page-builder-ee to the directory with Magento Commerce 2.3 alpha
8753
``` sh
88-
ln -s ../../../pagebuilder/app/code/Magento/PageBuilder
54+
cp -r magento2-page-builder/app project-enterprise-edition/
55+
cp -r magento2-page-builder/dev project-enterprise-edition/
56+
cp -r magento2-page-builder-ee/app project-enterprise-edition/
57+
cp -r magento2-page-builder-ee/dev project-enterprise-edition/
8958
```
90-
5. Return to the root directory of your Magento application and install the PageBuilder module using the following command:
59+
6. Enable Page Builder module using the following command:
9160
``` sh
9261
bin/magento setup:upgrade
9362
```
@@ -96,60 +65,13 @@ Do not use this installation method for evaluation or production instances.
9665

9766
When a new version of Page Builder is available, destroy your existing 2.3.0-alpha instance and follow the [composer](install.md#composer-installation) or [GitHub](install.md#github-installation) installation steps.
9867

99-
## Installing Node.js dependencies
100-
101-
If you plan to contribute to Page Builder, you need to install Node.js dependencies to compile TypeScript.
102-
103-
Navigate to the `pagebuilder` directory and install PageBuilder dependencies using the following command:
104-
``` sh
105-
cd pagebuilder && yarn install
106-
```
107-
108-
Then you can run `npx gulp` to watch changes to TypeScript files and compile.
109-
110-
To check for TypeScript errors, you can run `npx tslint --fix -p tsconfig.json`.
111-
112-
## Activation
113-
114-
Follow these steps to activate PageBuilder in the Admin:
115-
116-
1. Navigate to the Admin section of you Magento instance.
117-
2. In the **Stores** tab, select **Configuration** under the Settings group.
118-
3. In the **General** group on the page, select **Content Management**.
119-
4. Under **Advanced Content Tools**, select **Yes** for **Enable Page Builder**.
120-
5. Click **Save Config**
121-
122-
## Disable PageBuilder
123-
124-
We recommend you deactivate the PageBuilder editor through the Admin instead of disabling the module itself.
125-
This allows the PageBuilder module to continue rendering the content on the storefront even if the editor is not used in the Admin.
126-
127-
If you disabled or uninstalled the entire PageBuilder module instead of just the editor, you need to do the following to continue using PageBuilder-built content:
128-
129-
1. Implement PageBuilder widgets and initialize them on dynamic blocks since JavaScript functionality provided by PageBuilder will no longer work.
130-
2. Change the layout in the database for entities that use the full width layout to prevent blank layout content.
131-
13268
## Troubleshooting
13369

134-
### Common access problems
135-
136-
If you are having trouble installing PageBuilder, please verify that the `MAGEID` account you provided for the Early Access Program (EAP) belongs to an active Magento partner account.
137-
138-
**Note:**
139-
*Your company may have multiple Magento accounts, and only one or two may be active.*
140-
*Ask your company to provide you with an active Magento account.*
141-
142-
Log into www.magento.com and see if the **Support** and **Downloads** tabs are available.
143-
144-
![Support and downloads tabs](images/support-downloads-tab.png)
145-
146-
If these tabs do not appear in your Magento account, it is not an active Magento partner account, and
147-
you will not be able to access PageBuilder.
70+
### Page Builder repositories access problems
14871

149-
If you provided incorrect `MAGEID` by mistake and have another one that is valid, please resubmit this form:
150-
https://goo.gl/forms/unvuDikl9wydmKt12
72+
If you are having trouble accessing PageBuilder repositories, please contact [Igor Melnykov] or [Olena Tkacheva].
15173

152-
### Errors
74+
### 2.3 alpha installation problems
15375

15476
If you run into any of the following errors:
15577

@@ -161,6 +83,6 @@ Could not find a matching version of package magento/module-page-builder-commerc
16183
```
16284
16385
Check your composer keys in the `auth.json` file.
164-
If these keys are correct and you still encounter these errors, please contact [Olena Tkacheva].
86+
If these keys are correct and you still encounter these errors, please contact [Igor Melnykov] or [Olena Tkacheva].
16587
16688
[Olena Tkacheva]: https://magentocommeng.slack.com/messages/@UAFV915FB

0 commit comments

Comments
 (0)