|
1 | 1 | # Install Page Builder Examples
|
2 | 2 |
|
3 |
| -You can find the code examples used, and referred to, within 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). This repo contains two types of examples: |
4 | 4 |
|
5 | 5 | - Fully functional modules
|
6 | 6 | - Files for how-to topics
|
7 | 7 |
|
8 | 8 | ## Fully functional modules
|
9 | 9 |
|
10 |
| -The following custom content type modules are here for you to download and install so you can learn by example: |
| 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 | 11 |
|
12 | 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 | 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 | 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.
|
15 | 15 |
|
| 16 | +## Installation |
| 17 | + |
| 18 | +Assuming you have Page Builder 1.0.0 already installed, you can install the example modules as follows: |
| 19 | + |
| 20 | +1. Clone the pagebuilder-examples repo: |
| 21 | + |
| 22 | + ```bash |
| 23 | + git clone https://github.com/magento-devdocs/pagebuilder-examples |
| 24 | + ``` |
| 25 | + |
| 26 | +2. Navigate to your `<Magento2_installation>/app/code/` directory. |
| 27 | + |
| 28 | +3. Copy or symlink the `Example` directory from your local `pagebuilder-examples` clone into your `app/code/` directory. |
| 29 | + |
| 30 | + **To Symlink**: |
| 31 | + ```bash |
| 32 | + ln -s <Relative_route_to_cloned_Example_directory> |
| 33 | + ``` |
| 34 | + |
| 35 | +  |
| 36 | + |
| 37 | +4. Enable the modules using the `setup:upgrade` command: |
| 38 | + |
| 39 | + ```bash |
| 40 | + bin/magento setup:upgrade |
| 41 | + ``` |
| 42 | + |
| 43 | +5. Navigate to a Page Builder instance to ensure the example content types appear in the Page Builder panel, as shown here: |
| 44 | + |
| 45 | +  |
| 46 | + |
| 47 | + |
16 | 48 | ## Files for how-to topics
|
17 | 49 |
|
18 | 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.
|
|
0 commit comments