|
1 | 1 | # Install Page Builder
|
2 | 2 |
|
3 |
| -## Prerequisites |
| 3 | +<style type="text/css" style="display: none"> |
| 4 | +strong { |
| 5 | + color: #990000; |
| 6 | +} |
| 7 | +</style> |
4 | 8 |
|
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`. |
6 | 9 |
|
7 |
| -## Installation steps |
| 10 | +How you install the pre-release version of Page Builder depends on whether or not you are a member of the Early Adopters Program (EAP): |
| 11 | +- **All Partners** (not EAP members) must use the [GitHub installation](#githubInstructions). |
| 12 | +- **EAP Members** can install using the [Composer installation](#composerInstallation). |
| 13 | + |
| 14 | +## Prerequisite for both installations |
| 15 | + |
| 16 | +Magento 2.3+ Commerce -- Installation instructions can be found from the [DevDocs installation guide](https://devdocs.magento.com/guides/v2.3/install-gde/bk-install-guide.html). |
| 17 | + |
| 18 | +## **All Partners**: GitHub Installation {#githubInstructions} |
| 19 | + |
| 20 | +Partners who are not members of the Early Adopters Program (EAP) must install the pre-release version of Page Builder by cloning the Page Builder GitHub repository (https://github.com/magento/magento2-page-builder) into a development instance of Magento. |
| 21 | +Before installing Page Builder, make sure you have the following: |
| 22 | + |
| 23 | +* A local development installation of Magento 2.3.0 alpha |
| 24 | +* Access to the Page Builder repository |
| 25 | +* [Yarn package manager](https://yarnpkg.com/en/) |
| 26 | + |
| 27 | +1. Navigate to the root directory of your Magento application. |
| 28 | + |
| 29 | +2. Clone the Page Builder repository as a subdirectory using the following command: |
| 30 | + ``` bash |
| 31 | + git clone git@github.com:magento/magento2-page-builder.git pagebuilder |
| 32 | + ``` |
| 33 | + |
| 34 | +3. Return to the root directory of your Magento application and navigate to `app/code/Magento` |
| 35 | + |
| 36 | +4. In the Magento modules directory, link the Page Builder module code to the application code using the following command: |
| 37 | + ``` bash |
| 38 | + ln -s ../../../pagebuilder/app/code/Magento/PageBuilder |
| 39 | + ``` |
| 40 | + |
| 41 | +5. Return to the root directory of your Magento application and install the Page Builder module using the following command: |
| 42 | + ``` bash |
| 43 | + bin/magento setup:upgrade |
| 44 | + ``` |
| 45 | + |
| 46 | +### Updating GitHub installation |
| 47 | + |
| 48 | +When a new version of Page Builder is available, delete your previous Page Builder clone/subdirectory and clone the latest again. |
| 49 | + |
| 50 | +### Installing Node.js dependencies |
| 51 | + |
| 52 | +If you plan to contribute to Page Builder, you need to install Node.js dependencies to compile TypeScript. |
| 53 | + |
| 54 | +Navigate to the `pagebuilder` directory and install Page Builder dependencies using the following command: |
| 55 | +``` sh |
| 56 | +cd pagebuilder && yarn install |
| 57 | +``` |
| 58 | + |
| 59 | +Then you can run `npx gulp` to watch changes to TypeScript files and compile. |
| 60 | +To check for TypeScript errors, you can run `npx tslint --fix -p tsconfig.json`. |
| 61 | + |
| 62 | +## **EAP Participants Only**: Composer Installation {#composerInstallation} |
| 63 | + |
| 64 | +To use the Composer installation described below, 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`. |
| 65 | +If you are experiencing problems _as an EAP member_, please contact us at `pagebuilderEAP@adobe.com`. |
8 | 66 |
|
9 | 67 | {: .bs-callout .bs-callout-info }
|
10 | 68 | 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.
|
11 | 69 |
|
12 |
| -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.** |
13 |
| - |
14 |
| -2. Ensure your composer has `minimum-stability` set to `beta` as follows: |
| 70 | +1. Ensure your composer has `minimum-stability` set to `beta` as follows: |
15 | 71 | ```
|
16 | 72 | composer config minimum-stability beta
|
17 | 73 | ```
|
18 | 74 |
|
19 |
| -3. Navigate to the root of the project and require the `magento/module-page-builder-commerce` package: |
| 75 | +2. Navigate to the root of the project and require the `magento/module-page-builder-commerce` package: |
20 | 76 | ```
|
21 | 77 | composer require magento/page-builder-commerce:^1.0.0
|
22 | 78 | ```
|
23 | 79 |
|
24 |
| -4. Enable the module within Magento: |
| 80 | +3. Enable the module within Magento: |
25 | 81 | ``` sh
|
26 | 82 | bin/magento setup:upgrade
|
27 | 83 | ```
|
28 | 84 |
|
29 |
| -5. Activate Page Builder from the Admin UI as described in [Activate Page Builder](activate-pagebuilder.md). |
30 |
| -
|
31 |
| -## Updating |
| 85 | +4. Activate Page Builder from the Admin UI as described in [Activate Page Builder](activate-pagebuilder.md). |
32 | 86 |
|
33 |
| -We plan to release a new version of Page Builder beta every week. |
34 |
| -This can be install by completing a `composer update` within your project. |
| 87 | +### Updating Composer installation |
35 | 88 |
|
36 |
| -## Troubleshooting |
| 89 | +This can be installed by completing a `composer update` within your project. |
37 | 90 |
|
38 | 91 | ### Composer installation issues
|
39 | 92 |
|
|
0 commit comments