Skip to content

Commit aa69501

Browse files
authored
Merge pull request #1 from magento-devdocs/MC-4272
MC-4272: Update content type docs
2 parents 9ebaf06 + 6158037 commit aa69501

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+648
-174
lines changed

README.md

+33-18
Original file line numberDiff line numberDiff line change
@@ -17,38 +17,54 @@ The PageBuilder Early Access Program (EAP) gives partners the following perks:
1717

1818
We offer one method for installing PageBuilder:
1919

20-
* As a [Composer package] - use this option if you do not plan to contribute to the PageBuilder code repository.
2120
* Using the [GitHub repository] - use this option to install PageBuilder from the GitHub repository and contribute to the code.
2221

23-
[Composer package]: docs/install-pagebuilder.md#composer-installation
24-
[GitHub repository]: docs/install-pagebuilder.md#github-installation
22+
[GitHub repository]: docs/install-pagebuilder.md
2523

2624
<!-- {% comment %} -->
2725

2826
## Developer documentation
2927

3028
### Getting Started
3129

32-
1. [Introduction](docs/getting-started/introduction.md)
33-
2. [Install Page Builder](docs/getting-started/install-pagebuilder.md)
34-
3. [Activate Page Builder](docs/getting-started/activate-pagebuilder.md)
35-
36-
### Customizations
37-
38-
* [Block chooser](docs/customizations/block-chooser.md)
39-
* [Full-width page layouts](docs/customizations/full-width-page-layouts.md)
40-
* [Responsive layouts](docs/customizations/responsive-layouts.md)
41-
* [Storefront customization](docs/customizations/storefront-customization.md)
42-
* [Visual selects](docs/customizations/visual-selects.md)
43-
* [Additional data configuration](docs/customizations/additional-data-configuration.md)
44-
* [Product conditions](docs/customizations/product-conditions.md)
45-
* [Server-side rendered previews](docs/customizations/server-side-rendered-previews.md)
30+
* [Introduction](docs/getting-started/introduction.md)
31+
* [Install Page Builder](docs/getting-started/install-pagebuilder.md)
32+
* [Activate Page Builder](docs/getting-started/activate-pagebuilder.md)
33+
* [View Page Builder](docs/getting-started/view-pagebuilder.md)
34+
35+
### Create a content type
36+
37+
* [Overview](docs/create-basic-content-type/overview.md)
38+
* [Step 1: Add configuration](docs/create-basic-content-type/step-1-add-configuration.md)
39+
* [Step 2: Add templates](docs/create-basic-content-type/step-2-add-templates.md)
40+
* [Step 3: Add components](docs/create-basic-content-type/step-3-add-components.md)
41+
* [Step 4: Add form editor](docs/create-basic-content-type/step-4-add-form-editor.md)
42+
* [Step 5: Add layout](docs/create-basic-content-type/step-5-add-layout.md)
43+
* [Step 6: Add styles and icons](docs/create-basic-content-type/step-6-add-styles-icons.md)
44+
* [Step 7: Add frontend widget](docs/create-basic-content-type/step-7-add-frontend-widget.md)
45+
* [What's next](docs/create-basic-content-type/whats-next.md)
46+
47+
### Configurations
48+
49+
* [Main configurations](docs/configurations/content-type-configuration.md)
50+
* [Additional configurations](docs/configurations/additional-configurations.md)
51+
* [Panel configurations](docs/configurations/panel-configurations.md)
52+
* [Option menu configurations](docs/configurations/option-menu-configurations.md)
53+
* [Iconography](docs/configurations/iconography.md)
54+
* [Block chooser configuration](docs/configurations/block-chooser-configuration.md)
55+
* [Full-width page layout configuration](docs/configurations/full-width-page-layout-configuration.md)
56+
* [Responsive layout configuration](docs/configurations/responsive-layout-configuration.md)
57+
* [Storefront configuration](docs/configurations/storefront-configuration.md)
58+
* [Selector configuration](docs/configurations/selector-configuration.md)
59+
* [Product conditions configuration](docs/configurations/product-conditions-configuration.md)
60+
* [Server-side rendered previews](docs/configurations/server-side-rendered-previews.md)
4661

4762
### How Tos
4863

4964
* [How to develop a new content type](docs/how-to/how-to-develop-new-content-type.md)
5065
* [How to develop a container content type](docs/how-to/how-to-develop-container-content-type.md)
5166
* [How to use the Image Uploader](docs/how-to/how-to-use-image-uploader.md)
67+
* [How to use the Image Uploader](docs/how-to/how-to-use-image-uploader.md)
5268
* [How to add inline text editing](docs/how-to/how-to-add-inline-text-editing.md)
5369
* [How to add a custom toolbar](docs/how-to/how-to-add-custom-toolbar.md)
5470
* [How to convert product attribute fields to use Page Builder](docs/how-to/how-to-convert-product-attributes-to-use-pagebuilder.md)
@@ -59,7 +75,6 @@ We offer one method for installing PageBuilder:
5975
* [Architecture](docs/reference/architecture.md)
6076
* [Events](docs/reference/events.md)
6177
* [Knockout bindings](docs/reference/knockout-bindings.md)
62-
* [Configuration](docs/reference/configuration.md)
6378
* [Master format](docs/reference/master-format.md)
6479

6580
### Migration

docs/_pagebuilder.yml

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

0 commit comments

Comments
 (0)