Skip to content

Commit 1e002a0

Browse files
davemacaulaydavemacaulay
authored
Merge pull request #234 from magento-devdocs/develop
[Owls] Update PB repo readme to include GitHub install instructions per Olena
2 parents 3c5edfa + fa0864e commit 1e002a0

File tree

2 files changed

+201
-1
lines changed

2 files changed

+201
-1
lines changed

‎README.md

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

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

12+
## GitHub installation only
13+
14+
**The pre-release version of Page Builder MUST be installed by cloning the GitHub repos as described here.**
15+
16+
Before installing Page Builder, make sure you have:
17+
18+
* A local development installation of Magento Commerce 2.3+
19+
* Access to the Page Builder repository
20+
* [npm package manager](https://www.npmjs.com/get-npm)
21+
22+
1. Clone the Page Builder repos into the root directory of your Magento Commerce 2.3+ installation:
23+
24+
```bash
25+
git clone https://github.com/magento/magento2-page-builder
26+
git clone https://github.com/magento/magento2-page-builder-ee
27+
```
28+
29+
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:
30+
31+
```bash
32+
php dev/tools/build-ee.php --command=link --ee-source="magento2-page-builder" --ce-source="."
33+
php dev/tools/build-ee.php --command=link --ee-source="magento2-page-builder-ee" --ce-source="."
34+
```
35+
36+
The results should look like this:
37+
38+
![Symlinks to Page Builder](docs/images/symlinked-pagebuilder.png)
39+
40+
3. Enable the Page Builder module using the following command:
41+
42+
```bash
43+
bin/magento setup:upgrade
44+
```
45+
1246
## Developer documentation
1347

1448
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)
49+
[Page Builder developer documentation](https://devdocs.magedevteam.com/72/page-builder/docs/getting-started/introduction.html)
1650

1751
## Contribute to Page Builder
1852

‎docs/page-builder.yml

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
label: Page Builder
2+
url: /page-builder/
3+
versionless: true
4+
pages:
5+
- label: Getting started
6+
url: /page-builder/getting-started/introduction.html
7+
versionless: true
8+
children:
9+
- label: Install Page Builder
10+
url: /page-builder/getting-started/install-pagebuilder.html
11+
versionless: true
12+
13+
- label: Activate Page Builder
14+
url: /page-builder/getting-started/activate-pagebuilder.html
15+
versionless: true
16+
17+
- label: View Page Builder
18+
url: /page-builder/getting-started/view-pagebuilder.html
19+
versionless: true
20+
21+
- label: Create content type
22+
versionless: true
23+
children:
24+
- label: Overview
25+
url: /page-builder/create-basic-content-type/overview.html
26+
versionless: true
27+
28+
- label: Step 1. Add configuration
29+
url: /page-builder/create-basic-content-type/step-1-add-configuration.html
30+
versionless: true
31+
32+
- label: Step 2. Add templates
33+
url: /page-builder/create-basic-content-type/step-2-add-templates.html
34+
versionless: true
35+
36+
- label: Step 3. Add components
37+
url: /page-builder/create-basic-content-type/step-3-add-components.html
38+
versionless: true
39+
40+
- label: Step 4. Add form
41+
url: /page-builder/create-basic-content-type/step-4-add-form.html
42+
versionless: true
43+
44+
- label: Step 5. Add styles
45+
url: /page-builder/create-basic-content-type/step-5-add-styles.html
46+
versionless: true
47+
48+
- label: Step 6. Add an icon
49+
url: /page-builder/create-basic-content-type/step-6-add-icon.html
50+
versionless: true
51+
52+
- label: What's next?
53+
url: /page-builder/create-basic-content-type/whats-next.html
54+
versionless: true
55+
56+
- label: Configurations
57+
versionless: true
58+
children:
59+
- label: Content type configuration
60+
url: /page-builder/configurations/content-type-configuration.html
61+
versionless: true
62+
63+
- label: Additional configurations
64+
url: /page-builder/configurations/additional-configurations.html
65+
versionless: true
66+
67+
- label: Panel configurations
68+
url: /page-builder/configurations/panel-configurations.html
69+
versionless: true
70+
71+
- label: Icons and images
72+
url: /page-builder/configurations/icons-and-images.html
73+
versionless: true
74+
75+
- label: Block chooser
76+
url: /page-builder/configurations/block-chooser-configuration.html
77+
versionless: true
78+
79+
- label: Full-width page layouts
80+
url: /page-builder/configurations/full-width-page-layout-configuration.html
81+
versionless: true
82+
83+
- label: Responsive layouts
84+
url: /page-builder/configurations/responsive-layout-configuration.html
85+
versionless: true
86+
87+
- label: Storefront customization
88+
url: /page-builder/configurations/storefront-configuration.html
89+
versionless: true
90+
91+
- label: Selector configuration
92+
url: /page-builder/configurations/selector-configuration.html
93+
versionless: true
94+
95+
- label: Product conditions
96+
url: /page-builder/configurations/product-conditions-configuration.html
97+
versionless: true
98+
99+
- label: Server-side rendered previews
100+
url: /page-builder/configurations/server-side-rendered-previews.html
101+
versionless: true
102+
103+
- label: How tos
104+
versionless: true
105+
children:
106+
- label: How to develop a container content type
107+
url: /page-builder/how-to/how-to-develop-container-content-type.html
108+
versionless: true
109+
110+
- label: How to use the Image Uploader
111+
url: /page-builder/how-to/how-to-use-image-uploader.html
112+
versionless: true
113+
114+
- label: How to add inline text editing
115+
url: /page-builder/how-to/how-to-add-inline-text-editing.html
116+
versionless: true
117+
118+
- label: How to add a custom toolbar
119+
url: /page-builder/how-to/how-to-add-custom-toolbar.html
120+
versionless: true
121+
122+
- label: How to convert product attribute fields to use Page Builder
123+
url: /page-builder/how-to/how-to-convert-product-attributes-to-use-pagebuilder.html
124+
versionless: true
125+
126+
- label: Reference
127+
versionless: true
128+
children:
129+
- label: Architecture
130+
url: /page-builder/reference/architecture.html
131+
versionless: true
132+
133+
- label: Data Store
134+
url: /page-builder/reference/data-store.html
135+
versionless: true
136+
137+
- label: Events
138+
url: /page-builder/reference/events.html
139+
versionless: true
140+
141+
- label: Knockout bindings
142+
url: /page-builder/reference/knockout-bindings.html
143+
versionless: true
144+
145+
- label: Migration to Page Builder
146+
versionless: true
147+
children:
148+
- label: Migrate from BlueFoot
149+
url: /page-builder/migration/migrate-from-bluefoot.html
150+
versionless: true
151+
152+
- label: Migrate custom content types from BlueFoot
153+
url: /page-builder/migration/migrate-custom-content-types-from-bluefoot.html
154+
versionless: true
155+
156+
- label: Release notes
157+
url: /page-builder/release-notes.html
158+
versionless: true
159+
160+
- label: Component status
161+
url: /page-builder/comp-status2.html
162+
versionless: true
163+
164+
- label: Contribution guide
165+
url: https://github.com/magento/magento2-page-builder/CONTRIBUTING.md
166+
versionless: true

0 commit comments

Comments
 (0)