Skip to content

Commit 65b4d60

Browse files
committed
MAGEDOC-3558: Docs for changed repo access
1 parent 3707ed5 commit 65b4d60

File tree

3 files changed

+32
-24
lines changed

3 files changed

+32
-24
lines changed

docs/getting-started/install-pagebuilder.md

Lines changed: 31 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Install Page Builder
22

3-
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):
3+
How you install the pre-release version of Page Builder depends on whether you are a member of the Early Adopters Program (EAP):
44

55
- **All Partners** (not EAP members) must use the [GitHub installation](#githubInstructions).
66
- **EAP Members** can install using the [Composer installation](#composerInstallation).
@@ -14,65 +14,73 @@ Magento 2.3+ Commerce -- Use the installation instructions from the [DevDocs ins
1414
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.
1515
Before installing Page Builder, make sure you have:
1616

17-
* A local development installation of Magento 2.3.0 alpha
17+
* A local development installation of Magento Commerce 2.3.0
1818
* Access to the Page Builder repository
19-
* [Yarn package manager](https://yarnpkg.com/en/)
19+
* [npm package manager](https://www.npmjs.com/get-npm)
2020

21-
1. Navigate to the root directory of your Magento application.
21+
1. Clone the Page Builder repos into the root directory of your Magento Commerce installation:
2222

23-
2. Clone the Page Builder repository as a subdirectory using the following command:
24-
``` bash
25-
git clone git@github.com:magento/magento2-page-builder.git pagebuilder
23+
```bash
24+
git clone https://github.com/magento/magento2-page-builder
25+
git clone https://github.com/magento/magento2-page-builder-ee
2626
```
27-
28-
3. Return to the root directory of your Magento application and navigate to `app/code/Magento`
2927

30-
4. In the Magento modules directory, link the Page Builder module code to the application code using the following command:
31-
``` bash
32-
ln -s ../../../pagebuilder/app/code/Magento/PageBuilder
28+
2. Use the `dev/tools/build-ee.php` script to symlink the `magento2-page-builder` and `magento2-page-builder-ee` repos into your Magento Commerce installation:
29+
30+
```bash
31+
php dev/tools/build-ee.php --command=link --ee-source="magento2-page-builder" --ce-source="."
32+
php dev/tools/build-ee.php --command=link --ee-source="magento2-page-builder-ee" --ce-source="."
3333
```
3434

35-
5. Return to the root directory of your Magento application and install the Page Builder module using the following command:
36-
``` bash
35+
The results should look like this:
36+
37+
![Symlinks to Page Builder](../images/symlinked-pagebuilder.png)
38+
39+
3. Enable the Page Builder module using the following command:
40+
41+
```bash
3742
bin/magento setup:upgrade
3843
```
3944

4045
### Updating GitHub installation
4146

42-
When a new version of Page Builder is available, delete your previous Page Builder clone/subdirectory and clone the latest again.
47+
When a new version of Page Builder is available, simply pull down the latest versions from `magento/magento2-page-builder` and `magento/magento2-page-builder-ee`.
4348

4449
### Installing Node.js dependencies
4550

4651
If you plan to contribute to Page Builder, you need to install Node.js dependencies to compile TypeScript.
4752

4853
Navigate to the `pagebuilder` directory and install Page Builder dependencies using the following command:
49-
``` sh
50-
cd pagebuilder && yarn install
54+
55+
```bash
56+
cd pagebuilder && npm install
5157
```
5258

53-
Then you can run `npx gulp` to watch changes to TypeScript files and compile.
54-
To check for TypeScript errors, you can run `npx tslint --fix -p tsconfig.json`.
59+
After installing the npm packages, you can run `npm run start`. This command watches for changes to your TypeScript files, compiles, and checks for errors.
5560

5661
## **EAP Participants Only**: Composer Installation {#composerInstallation}
5762

5863
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 get access to the Page Builder Composer packages through `repo.magento.com`.
5964
If you are experiencing problems _as an EAP member_, please contact us at `pagebuilderEAP@adobe.com`.
6065

6166
{: .bs-callout .bs-callout-info }
62-
If you have had a previous version of Magento 2.3.0 or Page Builder installed, clear your composer cache (`composer clearcache`) before you install the latest packages.
67+
If you already have Magento 2.3.0 or Page Builder installed, clear your composer cache (`composer clearcache`) before you install the latest packages.
6368

6469
1. Ensure your composer has `minimum-stability` set to `beta`:
65-
```
70+
71+
```bash
6672
composer config minimum-stability beta
6773
```
6874

6975
2. Navigate to the root of the project and require the `magento/module-page-builder-commerce` package:
70-
```
76+
77+
```bash
7178
composer require magento/page-builder-commerce:^1.0.0
7279
```
7380

7481
3. Enable the module within Magento:
75-
``` sh
82+
83+
``` bash
7684
bin/magento setup:upgrade
7785
```
7886

docs/images/symlinked-pagebuilder.png

22.9 KB
Loading

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Page Builder pre-release access
22

3-
Pre-release access to Page Builder is opened to all Magento Partners with *no support* from Magento team.
3+
Pre-release access to Page Builder is opened to all Magento Partners with *no support* from Magento.
44
Use this access to:
55

66
- Explore extension points to build custom modules and integrations for 3rd party services, such as Facebook and Instagram.

0 commit comments

Comments
 (0)