Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 4899c3b

Browse files
authored
Change magento-devdocs to commerce-docs
2 parents 71fb53b + 6aee02e commit 4899c3b

File tree

6 files changed

+23
-23
lines changed

6 files changed

+23
-23
lines changed

docs/content-types/customize/add-custom-toolbar.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ define([
8282

8383
## Step 3: Add toolbar markup
8484

85-
Within your `preview.html` template, use a `div` element (with CSS class and events) to wrap whichever element in your template you want the toolbar to act on. For example, the custom [Quote content type](https://github.com/magento-devdocs/pagebuilder-examples/blob/master/Quote/Custom/view/adminhtml/web/template/content-type/custom-quote/default/preview.html) wraps its `<blockquote>` element within a `div` with the toolbar's CSS class and event binding, as shown here:
85+
Within your `preview.html` template, use a `div` element (with CSS class and events) to wrap whichever element in your template you want the toolbar to act on. For example, the custom [Quote content type](https://github.com/commerce-docs/pagebuilder-examples/blob/master/Quote/Custom/view/adminhtml/web/template/content-type/custom-quote/default/preview.html) wraps its `<blockquote>` element within a `div` with the toolbar's CSS class and event binding, as shown here:
8686

8787
```html
8888
<!--preview.html-->

docs/content-types/extend/add-appearances.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ Use `_module.less` for import statements
235235

236236
## Example Module
237237

238-
An example module for this topic is available for download in the [pagebuilder-examples repository](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/BannerApp/Appearance).
238+
An example module for this topic is available for download in the [pagebuilder-examples repository](https://github.com/commerce-docs/pagebuilder-examples/tree/master/BannerApp/Appearance).
239239

240240
## Final thoughts
241241

docs/content-types/extend/extend-appearances.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ These steps describe the basic process for adding new style properties to existi
2323

2424
### Step 1: Create a Page Builder extension module
2525

26-
Use the [PB Modules CLI](https://github.com/magento-devdocs/pbmodules) to create the starting directory structure and files for a Banner extension. Instructions for using PB Modules can be found in the repo [`README.md`](https://github.com/magento-devdocs/pbmodules#pb-modules) file.
26+
Use the [PB Modules CLI](https://github.com/commerce-docs/pbmodules) to create the starting directory structure and files for a Banner extension. Instructions for using PB Modules can be found in the repo [`README.md`](https://github.com/commerce-docs/pbmodules#pb-modules) file.
2727

2828
1. Navigate to your `<magento-instance-root>/app/code/` directory and run the following command:
2929

3030
```terminal
31-
npx https://github.com/magento-devdocs/pbmodules.git
31+
npx https://github.com/commerce-docs/pbmodules.git
3232
```
3333
3434
1. Extend the `Banner` and complete the remaining prompts. When finished, you should have a complete directory structure and all the files you need (plus extras) to start extending the Banner.
@@ -166,7 +166,7 @@ Explaining UI component form fields is beyond the scope of this topic, but a few
166166

167167
| Elements | Description |
168168
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
169-
| `fieldset` | The fieldset `name` should match the name of the fieldset from the Banner's form. The `appearance_fieldset` is common to all the content type forms and, by default, appears at the top of the forms using the `sortOrder` of 10. If you used [PB Modules](https://github.com/magento-devdocs/pbmodules/), the `fieldset` node names were copied from the Banner's form, so you're all set. |
169+
| `fieldset` | The fieldset `name` should match the name of the fieldset from the Banner's form. The `appearance_fieldset` is common to all the content type forms and, by default, appears at the top of the forms using the `sortOrder` of 10. If you used [PB Modules](https://github.com/commerce-docs/pbmodules/), the `fieldset` node names were copied from the Banner's form, so you're all set. |
170170
| `field` | The field `name` should match your `style` node name in your `banner.xml` config file. The same is true if you are adding `attribute`, `css`, `html`, or `tag` nodes; their names should match the field names that supply their values. Fields also have a `sortOrder` you can use to place your field above or below existing fields. The `formElement` for a field describes the HTML form type, such as input, wysiwyg, select, checkbox and more. |
171171
| `argument > config` | Provides the initial configuration for the field, including the `default` value. We set our default `max_height` field to `400` (px). |
172172
| `settings` | Provides the field with a label, CSS styling, validation, and other properties as needed. |

docs/content-types/extend/extend-more-appearances.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ You may not understand all the details right away, but we hope that by providing
3030

3131
## Install the example module
3232

33-
To help you get started and follow along, we created an example module you can clone and install from [magento-devdocs/PageBuilderStylingOptions](https://github.com/magento-devdocs/PageBuilderStylingOptions). The instructions for installing the module are provided from the `README` file on the repo.
33+
To help you get started and follow along, we created an example module you can clone and install from [commerce-docs/PageBuilderStylingOptions](https://github.com/commerce-docs/PageBuilderStylingOptions). The instructions for installing the module are provided from the `README` file on the repo.
3434

3535
For this example module, we chose to extend the `Heading` content type by adding three new Heading fields: `Heading Colors`, `Heading Styles`, and `Heading Opacity`, as shown here:
3636

docs/pagebuilder-examples.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Learning by example is one of the best ways to absorb the knowledge you need whe
1010

1111
The Page Builder team members created these modules for educational purposes. They are not fully tested or guaranteed to work perfectly. However, we do our best to improve these examples and keep them updated with the latest releases of Page Builder.
1212

13-
You can find all our existing Page Builder examples in the [https://github.com/magento-devdocs/pagebuilder-examples](https://github.com/magento-devdocs/pagebuilder-examples) repo on GitHub. The repo contains two types of example modules:
13+
You can find all our existing Page Builder examples in the [https://github.com/commerce-docs/pagebuilder-examples](https://github.com/commerce-docs/pagebuilder-examples) repo on GitHub. The repo contains two types of example modules:
1414

1515
- Extension modules
1616
- Custom modules
@@ -19,34 +19,34 @@ You can find all our existing Page Builder examples in the [https://github.com/m
1919

2020
Extension modules are extensions of Page Builder's existing modules. Extending an existing module is often the best way to introduce new functionality to Page Builder. Our current extension modules are described here:
2121

22-
- **[Banner Extension](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/BannerExt/Extension)** — This module shows you how to customize an existing content type: the Banner. This is the completed module featured in the documentation topic [Extend an appearance](https://devdocs.magento.com/page-builder/docs/content-types/extend/extend-appearances.html). Created by [Bruce Denham](https://github.com/bdenham).
22+
- **[Banner Extension](https://github.com/commerce-docs/pagebuilder-examples/tree/master/BannerExt/Extension)** — This module shows you how to customize an existing content type: the Banner. This is the completed module featured in the documentation topic [Extend an appearance](https://devdocs.magento.com/page-builder/docs/content-types/extend/extend-appearances.html). Created by [Bruce Denham](https://github.com/bdenham).
2323

24-
- **[Banner Appearance](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/BannerApp/Appearance)** — This module shows you how to add a new appearance to the Banner. This is the completed module featured in the documentation topic [Add appearances](https://devdocs.magento.com/page-builder/docs/content-types/extend/add-appearances.html). Created by [Bruce Denham](https://github.com/bdenham).
24+
- **[Banner Appearance](https://github.com/commerce-docs/pagebuilder-examples/tree/master/BannerApp/Appearance)** — This module shows you how to add a new appearance to the Banner. This is the completed module featured in the documentation topic [Add appearances](https://devdocs.magento.com/page-builder/docs/content-types/extend/add-appearances.html). Created by [Bruce Denham](https://github.com/bdenham).
2525

26-
- **[Forms Extension](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/Forms/Extension)** — This module shows you how to remove fields and fieldsets from Page Builder's built-in forms. Created by [Bruce Denham](https://github.com/bdenham).
26+
- **[Forms Extension](https://github.com/commerce-docs/pagebuilder-examples/tree/master/Forms/Extension)** — This module shows you how to remove fields and fieldsets from Page Builder's built-in forms. Created by [Bruce Denham](https://github.com/bdenham).
2727

28-
- **[Button Extension](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/Button/Extension)** — This module shows how to add custom button types. Created by [Bruce Denham](https://github.com/bdenham).
28+
- **[Button Extension](https://github.com/commerce-docs/pagebuilder-examples/tree/master/Button/Extension)** — This module shows how to add custom button types. Created by [Bruce Denham](https://github.com/bdenham).
2929

30-
- **[Columns Extension](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/Columns/Extension)** — This module shows how to use breakpoints to control the responsive layout of columns. Created by [Bruce Denham](https://github.com/bdenham).
30+
- **[Columns Extension](https://github.com/commerce-docs/pagebuilder-examples/tree/master/Columns/Extension)** — This module shows how to use breakpoints to control the responsive layout of columns. Created by [Bruce Denham](https://github.com/bdenham).
3131

32-
- **[Deactivate PageBuilder](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/Deactivate/PageBuilder)** — This example module shows you how to disable Page Builder for a particular page in Magento, specifically Pages, Blocks, and Dynamic Blocks. Created by [Bruce Denham](https://github.com/bdenham).
32+
- **[Deactivate PageBuilder](https://github.com/commerce-docs/pagebuilder-examples/tree/master/Deactivate/PageBuilder)** — This example module shows you how to disable Page Builder for a particular page in Magento, specifically Pages, Blocks, and Dynamic Blocks. Created by [Bruce Denham](https://github.com/bdenham).
3333

34-
- **[Image LazyLoading](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/Image/LazyLoading)** — This module shows how to add lazy loading behavior to the Image content type. For this example, we use the [lazysizes](https://github.com/aFarkas/lazysizes) loader. Created by [Bruce Denham](https://github.com/bdenham).
34+
- **[Image LazyLoading](https://github.com/commerce-docs/pagebuilder-examples/tree/master/Image/LazyLoading)** — This module shows how to add lazy loading behavior to the Image content type. For this example, we use the [lazysizes](https://github.com/aFarkas/lazysizes) loader. Created by [Bruce Denham](https://github.com/bdenham).
3535

36-
- **[Slider Extension](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/Slider/Extension)** — This module shows you how to add `centerMode` and `centerPadding` settings from the [slick carousel](https://kenwheeler.github.io/slick/) used by the Slider. Create by [Bruce Denham](https://github.com/bdenham).
36+
- **[Slider Extension](https://github.com/commerce-docs/pagebuilder-examples/tree/master/Slider/Extension)** — This module shows you how to add `centerMode` and `centerPadding` settings from the [slick carousel](https://kenwheeler.github.io/slick/) used by the Slider. Create by [Bruce Denham](https://github.com/bdenham).
3737

38-
- **[Text Extension](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/Text/Extension)** — This module shows you how to customize the Page Builder's Text toolbar, integrate your own theme's typography, and add TinyMCE's `code` plugin to the toolbar so you can view the HTML code directly. Created by [Bruce Denham](https://github.com/bdenham).
38+
- **[Text Extension](https://github.com/commerce-docs/pagebuilder-examples/tree/master/Text/Extension)** — This module shows you how to customize the Page Builder's Text toolbar, integrate your own theme's typography, and add TinyMCE's `code` plugin to the toolbar so you can view the HTML code directly. Created by [Bruce Denham](https://github.com/bdenham).
3939

4040
## Custom modules
4141

4242
Custom modules create new content types for Page Builder. Creating a new content type is required when you want to introduce a completely new type of content structure to Page Builder. Our current custom modules are described here:
4343

44-
- **[Custom Quote](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/Quote/Custom)** — This module shows you how to create a content type for a customer testimonial. This is the completed Quote module featured in the documentation tutorial: [Creating content types](https://devdocs.magento.com/page-builder/docs/content-types/create/introduction.html). Created by [Bruce Denham](https://github.com/bdenham).
44+
- **[Custom Quote](https://github.com/commerce-docs/pagebuilder-examples/tree/master/Quote/Custom)** — This module shows you how to create a content type for a customer testimonial. This is the completed Quote module featured in the documentation tutorial: [Creating content types](https://devdocs.magento.com/page-builder/docs/content-types/create/introduction.html). Created by [Bruce Denham](https://github.com/bdenham).
4545

46-
- **[Custom Homepage Grid](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/Grid/Custom)** — This module shows you how to create a content type that recreates the layout of the Magento Luma-themed home page using a grid structure with grid items. Created by [Dave Macaulay](https://github.com/davemacaulay).
46+
- **[Custom Homepage Grid](https://github.com/commerce-docs/pagebuilder-examples/tree/master/Grid/Custom)** — This module shows you how to create a content type that recreates the layout of the Magento Luma-themed home page using a grid structure with grid items. Created by [Dave Macaulay](https://github.com/davemacaulay).
4747

48-
- **[Custom FAQ](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/FAQ/Custom)** — This module shows you how to create a content type for an FAQ page that uses an accordion for the questions and answers. Created by [Igor Melnikov](https://github.com/melnikovi).
48+
- **[Custom FAQ](https://github.com/commerce-docs/pagebuilder-examples/tree/master/FAQ/Custom)** — This module shows you how to create a content type for an FAQ page that uses an accordion for the questions and answers. Created by [Igor Melnikov](https://github.com/melnikovi).
4949

5050
## Installing the example modules
5151

52-
Use the instructions from the examples repo, found here: [https://github.com/magento-devdocs/pagebuilder-examples#installing-the-example-modules](https://github.com/magento-devdocs/pagebuilder-examples#installing-the-example-modules).
52+
Use the instructions from the examples repo, found here: [https://github.com/commerce-docs/pagebuilder-examples#installing-the-example-modules](https://github.com/commerce-docs/pagebuilder-examples#installing-the-example-modules).

docs/viewports/add-viewports.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ By default, Page Builder defines four responsive breakpoints, but only uses two
1111
![Add viewports illustration](../images/pagebuilder-adding-viewports.svg)
1212

1313
{: .bs-callout-info }
14-
**Example available**. An example for adding additional viewports is available for viewing and installing from: [https://github.com/magento-devdocs/pagebuilder-theme](https://github.com/magento-devdocs/pagebuilder-theme). This example uses an Admin theme, which is typically a best practice for production releases. But during development, you might find that using a module helps simplify your daily workflow. Especially if you're starting from scratch. Then you can even use the [PB Modules CLI](https://github.com/magento-devdocs/pbmodules) to create a starting module.
14+
**Example available**. An example for adding additional viewports is available for viewing and installing from: [https://github.com/commerce-docs/pagebuilder-theme](https://github.com/commerce-docs/pagebuilder-theme). This example uses an Admin theme, which is typically a best practice for production releases. But during development, you might find that using a module helps simplify your daily workflow. Especially if you're starting from scratch. Then you can even use the [PB Modules CLI](https://github.com/commerce-docs/pbmodules) to create a starting module.
1515

1616
## Steps for adding viewports
1717

18-
1. [Create an Admin theme]() or [Create a module](https://github.com/magento-devdocs/pbmodules). Of course you can skip this step if you already have either one.
18+
1. [Create an Admin theme]() or [Create a module](https://github.com/commerce-docs/pbmodules). Of course you can skip this step if you already have either one.
1919
1. [Add a view.xml file](). Use this file to define your configuration data for the additional viewports.
2020
1. [Add viewport configuration data]()
2121
1. [Add viewport CSS classes](). Create these classes to change the stage width for a selected viewport.
@@ -147,7 +147,7 @@ So let's add a button icon and CSS for the stage width to make the button look g
147147

148148
Page Builder uses SVG images for its existing viewport button icons. And while you _can_ use other image formats (like .png), we recommend using SVG icons that match Page Builder's existing icons.
149149

150-
For this exercise, you can [download the `switcher-tablet.svg` and `switcher-mobile-small.svg` images](https://github.com/magento-devdocs/pagebuilder-examples/tree/master/Columns/Extension/view/adminhtml/web/css/images/switcher) from our example repo.
150+
For this exercise, you can [download the `switcher-tablet.svg` and `switcher-mobile-small.svg` images](https://github.com/commerce-docs/pagebuilder-examples/tree/master/Columns/Extension/view/adminhtml/web/css/images/switcher) from our example repo.
151151

152152
After downloading, add the files to your theme or module's `web/css/images/switcher/` directory to match the URLs we set for our viewport `icon` nodes in `view.xml`.
153153

0 commit comments

Comments
 (0)