Skip to content

Commit 226e7a9

Browse files
committed
Merged with page-builder docs repo
2 parents 77c72e1 + bbb31ff commit 226e7a9

File tree

4 files changed

+44
-11
lines changed

4 files changed

+44
-11
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/64/page-builder/docs/getting-started/introduction.html)
1650

1751
## Contribute to Page Builder
1852

docs/CHANGELOG.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Changelog
22

3-
Here are the Page Builder beta release notes and the higher priority known issues. We are actively working on many of these items and will update this document with each beta release.
4-
53
## Beta 8 - February 19, 2019
64

75
- Resolved: Analytics module sequence issue.
@@ -84,3 +82,4 @@ Beta 7 has breaking changes due to renaming of several critical variables and pa
8482
* Using Page Builder within a slide out form has a degraded experience.
8583
* Left-side panel will not scroll with the user.
8684
* Dragging and dropping can become broken due to another instance of Page Builder being loaded.
85+

docs/create-basic-content-type/step-2-add-templates.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,10 +99,10 @@ The Quote `preview_template` (`preview.html`) is shown here in full, followed b
9999

100100
The `attr` attribute allows binding of data from the content type form (UI component) to the html elements in the template.
101101

102-
The value for `attr` is derived from the `element` name in the configuration file followed by `attributes`. For example, the `attr` value used to bind data for the `blockquote` on line 8 of the Quote `preview.html` is `attr="data.quote.attributes"`. This corresponds to the `element` named `quote` in the `quote.xml` configuration file, as shown here:
102+
The value for `attr` is derived from the `element` name in the configuration file followed by `attributes`. For example, the `attr` value used to bind data for the `blockquote` on line 8 of the Quote `preview.html` is `attr="data.quote.attributes"`. This corresponds to the `element` named `quote` in the `example_quote.xml` configuration file, as shown here:
103103

104104
```xml
105-
<!-- quote.xml -->
105+
<!-- example_quote.xml -->
106106
<element name="quote">
107107
<html name="quote_text" converter="Magento_PageBuilder/js/converter/html/tag-escaper"/>
108108
<css name="quote_css"/>
@@ -116,7 +116,7 @@ The nodes declared within an `element` define the bindings that can be applied t
116116
The `ko-style` attribute applies the `<style>` attributes from the form to a template element. For example, the `main` element for the Quote configuration defines several style bindings as shown here:
117117

118118
```xml
119-
<!-- quote.xml -->
119+
<!-- example_quote.xml -->
120120
<element name="main">
121121
<style name="text_align" source="text_align"/>
122122
<style name="border" source="border_style" converter="Magento_PageBuilder/js/converter/style/border-style"/>

docs/create-basic-content-type/step-4-add-form.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -252,13 +252,13 @@ Defines the data source for the field. The source` node's value corresponds to a
252252
```xml
253253
<field name="quote_text" sortOrder="10" formElement="textarea">
254254
<argument name="data" xsi:type="array">
255-
<item name="config" xsi:type="array">
256-
<item name="source" xsi:type="string">page</item>
257-
</item>
258-
</argument>
255+
<item name="config" xsi:type="array">
256+
<item name="source" xsi:type="string">page</item>
257+
</item>
258+
</argument>
259259
```
260260

261-
For example, the `quote_text` field above specifies that the `source` of its data should come from tthe data stored under the key `page` returned by the page's DataProvider.
261+
For example, the `quote_text` field above specifies that the `source` of its data should come from the data stored under the key `page` returned by the page's DataProvider.
262262

263263
### settings
264264

0 commit comments

Comments
 (0)