Skip to content

Commit 892b26e

Browse files
committed
MAGEDOC-3558: Docs for changed repo access
1 parent 7f03460 commit 892b26e

File tree

2 files changed

+77
-31
lines changed

2 files changed

+77
-31
lines changed

docs/getting-started/install-pagebuilder.md

Lines changed: 67 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,92 @@
11
# Install Page Builder
22

3-
## Prerequisites
3+
<style type="text/css" style="display: none">
4+
strong {
5+
color: #990000;
6+
}
7+
</style>
48

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`.
69

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`.
866

967
{: .bs-callout .bs-callout-info }
1068
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.
1169

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:
1571
```
1672
composer config minimum-stability beta
1773
```
1874

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:
2076
```
2177
composer require magento/page-builder-commerce:^1.0.0
2278
```
2379

24-
4. Enable the module within Magento:
80+
3. Enable the module within Magento:
2581
``` sh
2682
bin/magento setup:upgrade
2783
```
2884

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).
3286

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
3588

36-
## Troubleshooting
89+
This can be installed by completing a `composer update` within your project.
3790

3891
### Composer installation issues
3992

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 team.
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)