Skip to content

Commit 9a8363a

Browse files
committed
MAGEDOC-3644: Post GA release docs cleanup
Updated examples topic to include original authors for the example modules
1 parent 868d2cd commit 9a8363a

File tree

2 files changed

+27
-25
lines changed

2 files changed

+27
-25
lines changed
Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,36 @@
11
# Install Page Builder Examples
22

3-
You can find the Page Builder examples used in this documentation on GitHub in the [pagebuilder-examples repo](https://github.com/magento-devdocs/pagebuilder-examples). This repo contains two types of examples:
3+
You can find the Page Builder examples used in this documentation on GitHub in the [pagebuilder-examples repo](https://github.com/magento-devdocs/pagebuilder-examples). The repo contains three types of examples:
44

5-
- Fully functional modules
6-
- Files for how-to topics
5+
- Custom content type modules
6+
- Extension modules for existing content types
7+
- Example code for how-to topics
78

8-
## Fully functional modules
9+
## Custom content type modules
910

10-
To learn by example, the [Example directory](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/Example) on the repo provides the following custom content-type modules for you to download and install.
11+
To learn by example, the [Example directory](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/Example) on the repo provides the following custom content-type modules for you to download and install. Page Builder team members created these modules to serve as examples for learning. We will do our best to keep these updated and functioning with the latest releases of Page Builder.
1112

12-
- **[PageBuilderQuote](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/Example/PageBuilderQuote)**—This module shows you how to use a simple content type to stylize quotations for things like customer testimonials. This is the completed module featured in the [content type tutorial](../create-custom-content-type/overview.md).
13-
- **[PageBuilderGrid](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/Example/PageBuilderGrid)**—This module shows you how to create a content type to rebuild the Magento Luma home page using a grid structure with grid items.
14-
- **[PageBuilderFaq](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/Example/PageBuilderFaq)**—This module shows you how to create a content type for an FAQ page that uses an accordion for the questions and answers.
13+
- **[PageBuilderQuote](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/Example/PageBuilderQuote)** — Original author: [Bruce Denham](https://github.com/bdenham). This module shows you how to use a simple content type to stylize quotations for things like customer testimonials. This is the completed module featured in the [content type tutorial](../create-custom-content-type/overview.md). Original author: Bruce Denham
14+
- **[PageBuilderGrid](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/Example/PageBuilderGrid)** — Original author: [Dave Macaulay](https://github.com/davemacaulay). This module shows you how to create a content type to rebuild the Magento Luma home page using a grid structure with grid items.
15+
- **[PageBuilderFaq](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/Example/PageBuilderFaq)** — Original author: [Igor Melnikov](https://github.com/melnikovi). This module shows you how to create a content type for an FAQ page that uses an accordion for the questions and answers.
16+
17+
## Extension modules for existing content types
18+
19+
The [Example directory](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/Example) also provides the completed extension module described in the [Extend a content type tutorial](../extend-existing-content-type/overview.md). More extension modules will be added in the coming weeks.
20+
21+
## Example code for how-to topics
22+
23+
**In Progress**. The how-to directories in the repo correspond to the how-to topics in this documentation. Each how-to directory provides the files and code changes featured in the how-to topics.
24+
25+
For example, the topic [How to add a custom toolbar](../how-to/how-to-add-custom-toolbar.md), has a corresponding directory within the [pagebuilder-examples repo](https://github.com/magento-devdocs/pagebuilder-examples) called [how-to-add-custom-toolbar](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/how-to-add-custom-toolbar). This directory provides the files with the code changes you need to make in order to add a custom toolbar to the `PageBuilderQuote` module.
1526

1627
## Installation
1728

1829
Assuming you have Page Builder 1.0.0 already installed, you can install the example modules as follows:
1930

2031
1. Clone the pagebuilder-examples repo:
2132

22-
```bash
33+
```terminal
2334
git clone https://github.com/magento-devdocs/pagebuilder-examples
2435
```
2536
@@ -28,29 +39,20 @@ Assuming you have Page Builder 1.0.0 already installed, you can install the exam
2839
3. Copy or symlink the `Example` directory from your local `pagebuilder-examples` clone into your `app/code/` directory.
2940
3041
**To Symlink**:
31-
```bash
42+
```terminal
3243
ln -s <Relative_route_to_cloned_Example_directory>
3344
```
3445
3546
![Examples installation directory](../images/examples-install-location.png)
3647
3748
4. Enable the modules using the `setup:upgrade` command:
3849
39-
```bash
50+
```terminal
4051
bin/magento setup:upgrade
4152
```
4253

4354
5. Navigate to a Page Builder instance to ensure the example content types appear in the Page Builder panel, as shown here:
4455

4556
![Content type examples shown in panel](../images/example-content-types.png)
46-
47-
48-
## Files for how-to topics
49-
50-
The how-to directories in the repo correspond to the how-to topics in this documentation. They provide the files and code changes required by the how-to topic in order to add the given feature to the `PageBuilderQuote` module.
51-
52-
For example, the topic [How to add a custom toolbar](../how-to/how-to-add-custom-toolbar.md), has a corresponding directory within the [pagebuilder-examples repo](https://github.com/magento-devdocs/pagebuilder-examples) called [how-to-add-custom-toolbar](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/how-to-add-custom-toolbar). This directory provides the files with the code changes you need to make in order to add a custom toolbar to the `PageBuilderQuote` module.
53-
54-
5557

56-
58+

docs/getting-started/install-pagebuilder.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ Before installing Page Builder for making contributions, make sure you have the
1313

1414
1. Clone the Page Builder repos into the root directory of your Magento Commerce 2.3+ installation:
1515

16-
```bash
16+
```terminal
1717
git clone https://github.com/magento/magento2-page-builder
1818
git clone https://github.com/magento/magento2-page-builder-ee
1919
```
2020
2121
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:
2222
23-
```bash
23+
```terminal
2424
php dev/tools/build-ee.php --command=link --ee-source="magento2-page-builder" --ce-source="."
2525
php dev/tools/build-ee.php --command=link --ee-source="magento2-page-builder-ee" --ce-source="."
2626
```
@@ -31,7 +31,7 @@ Before installing Page Builder for making contributions, make sure you have the
3131
3232
3. Enable the Page Builder module using the following command:
3333
34-
```bash
34+
```terminal
3535
bin/magento setup:upgrade
3636
```
3737
@@ -45,7 +45,7 @@ If you plan to contribute to Page Builder, you need to install Node.js dependenc
4545
4646
Navigate to the `pagebuilder` directory and install Page Builder dependencies using the following command:
4747
48-
```bash
48+
```terminal
4949
cd pagebuilder && npm install
5050
```
5151

0 commit comments

Comments
 (0)