Skip to content

Commit 5aa2ad8

Browse files
committed
MAGEDOC-3558: Docs for changed repo access
Update to Readme page per Olena's request
1 parent 25dbf33 commit 5aa2ad8

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,42 @@ Use this access to:
99

1010
Should you find an issue in Page Builder functionality, please report it on GitHub.
1111

12+
## GitHub installation
13+
14+
Before installing Page Builder, make sure you have:
15+
16+
* A local development installation of Magento Commerce 2.3+
17+
* Access to the Page Builder repository
18+
* [npm package manager](https://www.npmjs.com/get-npm)
19+
20+
1. Clone the Page Builder repos into the root directory of your Magento Commerce 2.3+ installation:
21+
22+
```bash
23+
git clone https://github.com/magento/magento2-page-builder
24+
git clone https://github.com/magento/magento2-page-builder-ee
25+
```
26+
27+
2. From the root directory of your Magento Commerce installation, use the `dev/tools/build-ee.php` script to symlink `magento2-page-builder` and `magento2-page-builder-ee` repos into your Magento Commerce installation:
28+
29+
```bash
30+
php dev/tools/build-ee.php --command=link --ee-source="magento2-page-builder" --ce-source="."
31+
php dev/tools/build-ee.php --command=link --ee-source="magento2-page-builder-ee" --ce-source="."
32+
```
33+
34+
The results should look like this:
35+
36+
![Symlinks to Page Builder](../images/symlinked-pagebuilder.png)
37+
38+
3. Enable the Page Builder module using the following command:
39+
40+
```bash
41+
bin/magento setup:upgrade
42+
```
43+
1244
## Developer documentation
1345

1446
We will update the developer documentation frequently during beta. Please use this link to access the latest updates: 
15-
[Page Builder developer documentation](https://devdocs.magedevteam.com/ds_pagebuilder/page-builder/getting-started/install-pagebuilder.html)
47+
[Page Builder developer documentation](https://devdocs.magedevteam.com/page-builder/)
1648

1749
## Contribute to Page Builder
1850

0 commit comments

Comments
 (0)