Skip to content

Commit 6268201

Browse files
authored
Merge pull request #21 from magento-devdocs/MAGEDOC-3558
MAGEDOC-3558: Docs for changed repo access
2 parents ac50258 + f066f57 commit 6268201

File tree

3 files changed

+82
-34
lines changed

3 files changed

+82
-34
lines changed

docs/getting-started/install-pagebuilder.md

Lines changed: 72 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,94 @@
11
# Install Page Builder
22

3-
## Prerequisites
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

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 `[email protected]`.
5+
- **All Partners** (not EAP members) must use the [GitHub installation](#githubInstructions).
6+
- **EAP Members** can install using the [Composer installation](#composerInstallation).
67

7-
## Installation steps
8+
## Prerequisite for both installations
89

9-
{: .bs-callout .bs-callout-info }
10-
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.
10+
Magento 2.3+ Commerce -- Use the installation instructions from the [DevDocs installation guide](https://devdocs.magento.com/guides/v2.3/install-gde/bk-install-guide.html).
11+
12+
## **All Partners**: GitHub Installation {#githubInstructions}
13+
14+
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.
15+
Before installing Page Builder, make sure you have:
16+
17+
* A local development installation of Magento Commerce 2.3.0
18+
* Access to the Page Builder repository
19+
* [npm package manager](https://www.npmjs.com/get-npm)
1120

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.**
21+
1. Clone the Page Builder repos into the root directory of your Magento Commerce installation:
1322

14-
2. Ensure your composer has `minimum-stability` set to `beta` as follows:
23+
```bash
24+
git clone https://github.com/magento/magento2-page-builder
25+
git clone https://github.com/magento/magento2-page-builder-ee
1526
```
16-
composer config minimum-stability beta
27+
28+
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:
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="."
1733
```
34+
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:
1840

19-
3. Navigate to the root of the project and require the `magento/module-page-builder-commerce` package:
41+
```bash
42+
bin/magento setup:upgrade
2043
```
44+
45+
### Updating GitHub installation
46+
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`.
48+
49+
### Installing Node.js dependencies
50+
51+
If you plan to contribute to Page Builder, you need to install Node.js dependencies to compile TypeScript.
52+
53+
Navigate to the `pagebuilder` directory and install Page Builder dependencies using the following command:
54+
55+
```bash
56+
cd pagebuilder && npm install
57+
```
58+
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.
60+
61+
## **EAP Participants Only**: Composer Installation {#composerInstallation}
62+
63+
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`.
64+
If you are experiencing problems _as an EAP member_, please contact us at `[email protected]`.
65+
66+
{: .bs-callout .bs-callout-info }
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.
68+
69+
1. Ensure your composer has `minimum-stability` set to `beta`:
70+
71+
```bash
72+
composer config minimum-stability beta
73+
```
74+
75+
2. Navigate to the root of the project and require the `magento/module-page-builder-commerce` package:
76+
77+
```bash
2178
composer require magento/page-builder-commerce:^1.0.0
2279
```
2380

24-
4. Enable the module within Magento:
25-
``` sh
81+
3. Enable the module within Magento:
82+
83+
``` bash
2684
bin/magento setup:upgrade
2785
```
2886

29-
5. Activate Page Builder from the Admin UI as described in [Activate Page Builder](activate-pagebuilder.md).
30-
31-
## Updating
87+
4. Activate Page Builder from the Admin UI as described in [Activate Page Builder](activate-pagebuilder.md).
3288

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.
89+
### Updating Composer installation
3590

36-
## Troubleshooting
91+
You can install updates by completing a `composer update` within your project.
3792

3893
### Composer installation issues
3994

docs/images/symlinked-pagebuilder.png

22.9 KB
Loading

docs/index.md

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
1-
# PageBuilder Early Adopters Program
1+
# Page Builder pre-release access
22

3-
The Page Builder Early Adopters 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.
3+
Pre-release access to Page Builder is opened to all Magento Partners with *no support* from Magento.
4+
Use this access to:
5+
6+
- Explore extension points to build custom modules and integrations for 3rd party services, such as Facebook and Instagram.
7+
- Try out customization options and extend its functionality beyond its default features.
8+
- Preview to prepare a migration plan from BlueFoot 1.0 to Page Builder.
9+
10+
Should you find an issue in Page Builder functionality, please report it on GitHub.
811

912
## Installation
1013

@@ -77,14 +80,4 @@ See [Install Page Builder](getting-started/install-pagebuilder.md)
7780

7881
## Contribute to Page Builder
7982

80-
We appreciate any and all contributions to PageBuilder. If you are interested in contributing to this repository, please see our [Contribution guide](https://github.com/magento/magento2-page-builder/blob/develop/CONTRIBUTING.md).
81-
82-
## Page Builder updates from the Magento core team
83-
84-
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.
85-
86-
## Contact us
87-
88-
To participate in technical discussions and ask questions, join us in [Slack], where a number of Page Builder team members are present.
89-
90-
[Slack]: https://magentocommeng.slack.com/messages/GANS1R4C9
83+
We appreciate any and all contributions to PageBuilder. If you are interested in contributing to this repository, please see our [Contribution guide](https://github.com/magento/magento2-page-builder/blob/develop/CONTRIBUTING.md).

0 commit comments

Comments
 (0)