Skip to content

Commit 78c5ba9

Browse files
bdenhambdenham
committed
MC-4181: Organize Existing Topics
1 parent 5da3bf7 commit 78c5ba9

File tree

6 files changed

+231
-8
lines changed

6 files changed

+231
-8
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@
44
**.d.js
55
/dev/tests/acceptance/vendor
66
static-error-log.xml
7+
.DS_Store

‎docs/CONTRIBUTING.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Contributing to Magento 2 code
2+
<!-- {% comment %} -->
3+
## Navigation
4+
5+
1. [Introduction]
6+
2. [Installation guide]
7+
3. **Contribution guide**
8+
1. [Overview](#overview)
9+
1. [Contribution requirements](#contribution-requirements)
10+
1. [Contribution process](#contribution-process)
11+
1. [Code of Conduct](#code-of-conduct)
12+
4. [Developer documentation]
13+
5. [Roadmap and known issues]
14+
6. [How to create custom PageBuilder content type container]
15+
16+
[Introduction]: introduction.md
17+
[Contribution guide]: CONTRIBUTING.md
18+
[Installation guide]: install.md
19+
[Developer documentation]: developer-documentation.md
20+
[Architecture overview]: architecture-overview.md
21+
[BlueFoot to PageBuilder data migration]: bluefoot-data-migration.md
22+
[Third-party content type migration]: new-content-type-example.md
23+
[Iconography]: iconography.md
24+
[Add image uploader to content type]: image-uploader.md
25+
[Module integration]: module-integration.md
26+
[Additional data configuration]: custom-configuration.md
27+
[Content type configuration]: content-type-configuration.md
28+
[How to add a new content type]: how-to-add-new-content-type.md
29+
[Events]: events.md
30+
[Bindings]: bindings.md
31+
[Master format]: master-format.md
32+
[Visual select]: visual-select.md
33+
[Reuse product conditions in content types]: product-conditions.md
34+
[Store component master format as widget directive]: widget-directive.md
35+
[Use the block chooser UI component]: block-chooser-component.md
36+
[Use the inline text editing component]: inline-editing-component.md
37+
[Render a backend content type preview]: content-type-preview.md
38+
[Custom Toolbar]: toolbar.md
39+
[Full width page layouts]: full-width-page-layouts.md
40+
[Add image uploader to content type]: image-uploader.md
41+
[Roadmap and Known Issues]: roadmap.md
42+
[How to create custom PageBuilder content type container]: how-to-create-custom-content-type-container.md
43+
<!-- {% endcomment %} -->
44+
## Overview
45+
46+
Contributions to the Magento 2 codebase are done using the fork & pull model.
47+
This contribution model has contributors maintaining their own copy of the forked codebase (which can easily be synced with the main copy). The forked repository is then used to submit a request to the base repository to “pull” a set of changes (hence the phrase “pull request”).
48+
49+
Contributions can take the form of new components/features, changes to existing features, tests, documentation (such as developer guides, user guides, examples, or specifications), bug fixes, optimizations or just good suggestions.
50+
51+
The Magento 2 development team will review all issues and contributions submitted by the community of developers in the first in, first out order. During the review we might require clarifications from the contributor. If there is no response from the contributor for two weeks, the issue is closed.
52+
53+
54+
## Contribution requirements
55+
56+
1. Contributions must adhere to [Magento coding standards](http://devdocs.magento.com/guides/v2.0/coding-standards/bk-coding-standards.html).
57+
2. Pull requests (PRs) must be accompanied by a meaningful description of their purpose. Comprehensive descriptions increase the chances of a pull request to be merged quickly and without additional clarification requests.
58+
3. Commits must be accompanied by meaningful commit messages.
59+
4. PRs which include bug fixing, must be accompanied with step-by-step description of how to reproduce the bug.
60+
3. PRs which include new logic or new features must be submitted along with:
61+
* Unit/integration test coverage where applicable.
62+
* Updated documentation in the module directory `app/code/PageBuilder/docs`.
63+
4. For large features or changes, please [open an issue](https://github.com/magento/magento2/issues) and discuss first. This may prevent duplicate or unnecessary effort, and it may gain you some additional contributors.
64+
5. All automated tests are passed successfully locally. After PR submitted Magento team will run builds on continuous integration environment.
65+
66+
## Contribution process
67+
68+
If you are a new GitHub user, we recommend that you create your own [free github account](https://github.com/signup/free). By doing that, you will be able to collaborate with the Magento 2 development team, “fork” the Magento 2 project and be able to easily send “pull requests”.
69+
70+
1. Search current [listed issues](https://github.com/magento/magento2-page-builder/issues) on GitHub (open or closed) and [list of known issues](roadmap.md#Known Issues) on our roadmap for similar proposals of intended contribution before starting work on a new contribution.
71+
2. Please contact us in Slack chanel if you want to work on issue from [list of known issues](roadmap.md#Known Issues).
72+
2. Review the [Contributor License Agreement](https://magento.com/legaldocuments/mca) if this is your first time contributing.
73+
3. Create and test your work.
74+
4. Fork the Magento 2 repository according to [Fork a repository instructions](http://devdocs.magento.com/guides/v2.0/contributor-guide/contributing.html#fork) and when you are ready to send us a pull request – follow [Create a pull request instructions](http://devdocs.magento.com/guides/v2.0/contributor-guide/contributing.html#pull_request). Instructions written for `https://github.com/magento/magento2` repository, but they also apply to `https://github.com/magento/magento2-page-builder`.
75+
5. Once your contribution is received, Magento 2 development team will review the contribution and collaborate with you as needed to improve the quality of the contribution.
76+
77+
## Code of Conduct
78+
79+
Please note that this project is released with a Contributor Code of Conduct. We expect you to agree to its terms when participating in this project.
80+
The full text is available in the repository [Wiki](https://github.com/magento/magento2/wiki/Magento-Code-of-Conduct).

‎docs/_config.pagebuilder.yml

Whitespace-only changes.

‎docs/_pagebuilder.yml

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
label: Page Builder
2+
pages:
3+
- label: Getting Started
4+
url: /page-builder/README.html
5+
versionless: true
6+
children:
7+
- label: Installation guide
8+
url: /page-builder/install.html
9+
versionless: true
10+
11+
- label: Activate Page Builder
12+
url: /page-builder/activation-deactivation.html
13+
versionless: true
14+
15+
- label: How Page Builder works
16+
url: /page-builder/how-pagebuilder-works.html
17+
versionless: true
18+
19+
# - label: Developer documentation
20+
# url: /page-builder/developer-documentation.html
21+
# versionless: true
22+
23+
- label: Reference
24+
versionless: true
25+
children:
26+
- label: Architecture overview
27+
url: /page-builder/architecture-overview.html
28+
versionless: true
29+
30+
- label: Iconography
31+
url: /page-builder/iconography.html
32+
versionless: true
33+
34+
- label: Events
35+
url: /page-builder/events.html
36+
versionless: true
37+
38+
- label: Bindings
39+
url: /page-builder/bindings.html
40+
versionless: true
41+
42+
- label: Content type configuration
43+
url: /page-builder/content-type-configuration.html
44+
versionless: true
45+
46+
- label: Custom toolbar
47+
url: /page-builder/toolbar.html
48+
versionless: true
49+
50+
- label: Master format
51+
url: /page-builder/master-format.html
52+
versionless: true
53+
54+
- label: Content Types
55+
versionless: true
56+
children:
57+
- label: Add custom logic to content types
58+
url: /page-builder/add-custom-logic.html
59+
versionless: true
60+
61+
- label: Add image uploader to content type
62+
url: /page-builder/image-uploader.html
63+
versionless: true
64+
65+
- label: Use the inline text editing component
66+
url: /page-builder/inline-editing-component.html
67+
versionless: true
68+
69+
- label: Visual select
70+
url: /page-builder/visual-select.html
71+
versionless: true
72+
73+
- label: BlueFoot to Page Builder data migration
74+
url: /page-builder/bluefoot-data-migration.html
75+
versionless: true
76+
77+
- label: Third-party content type migration
78+
url: /page-builder/new-content-type-example.html
79+
versionless: true
80+
81+
- label: Additional data configuration
82+
url: /page-builder/custom-configuration.html
83+
versionless: true
84+
85+
- label: Reuse product conditions in content types
86+
url: /page-builder/product-conditions.html
87+
versionless: true
88+
89+
- label: Render a backend content type preview
90+
url: /page-builder/content-type-preview.html
91+
versionless: true
92+
93+
- label: Store component master format as widget directive
94+
url: /page-builder/widget-directive.html
95+
versionless: true
96+
97+
- label: UI Components
98+
versionless: true
99+
children:
100+
- label: Use the block chooser UI component
101+
url: /page-builder/block-chooser-component.html
102+
versionless: true
103+
104+
- label: Module integration
105+
url: /page-builder/module-integration.html
106+
versionless: true
107+
108+
- label: Layouts
109+
versionless: true
110+
children:
111+
- label: Full width page layouts
112+
url: /page-builder/full-width-page-layouts.html
113+
versionless: true
114+
115+
- label: Custom themes
116+
url: /page-builder/custom-themes.html
117+
versionless: true
118+
119+
- label: Tutorials
120+
versionless: true
121+
children:
122+
- label: How to add a new content type
123+
url: /page-builder/how-to-add-new-content-type.html
124+
versionless: true
125+
126+
- label: How to create custom PageBuilder content type container
127+
url: /page-builder/how-to-create-custom-content-type-container.html
128+
versionless: true
129+
130+
- label: Contribution guide
131+
url: /page-builder/CONTRIBUTING.html
132+
versionless: true
133+
134+
# - label: Roadmap and Known Issues
135+
# url: /page-builder/roadmap.html
136+
# versionless: true

‎docs/how-pagebuilder-works.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# How Page Builder works
2+
3+
This page will provide info on how Page Builder converts the WYSIWYG editor into the drag and drop page designer that Page Builder provides.
4+
5+
TBW

‎docs/introduction.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
1-
# PageBuilder Module Documentation
1+
# Getting Started with PageBuilder
22

33
PageBuilder is a Content Management System(CMS) module for Magento 2.3 and above.
44
It replaces the default WYSIWYG Editor in the Admin area with a highly configurable drag-and-drop editing system.
55

6-
<!--{% comment %}-->
6+
This page should serve as a guide to introducing what will be covered in this documentation.
7+
8+
TBW
9+
10+
<!-- {% comment %} -->
711
## Navigation
812

913
1. **Introduction**
@@ -12,7 +16,6 @@ It replaces the default WYSIWYG Editor in the Admin area with a highly configura
1216
4. [Developer documentation]
1317
1. [Architecture overview]
1418
1. [BlueFoot to PageBuilder data migration]
15-
1. [Custom theme integration]
1619
1. [Third-party content type migration]
1720
1. [Iconography]
1821
1. [Add image uploader to content type]
@@ -31,17 +34,15 @@ It replaces the default WYSIWYG Editor in the Admin area with a highly configura
3134
1. [Render a backend content type preview]
3235
1. [Custom Toolbar]
3336
1. [Full width page layouts]
34-
1. [Add custom logic to content types]
3537
5. [Roadmap and known issues]
3638
6. [How to create custom PageBuilder content type container]
3739

3840
[Introduction]: introduction.md
39-
[Contribution guide]: ../CONTRIBUTING.md
41+
[Contribution guide]: CONTRIBUTING.md
4042
[Installation guide]: install.md
4143
[Developer documentation]: developer-documentation.md
4244
[Architecture overview]: architecture-overview.md
4345
[BlueFoot to PageBuilder data migration]: bluefoot-data-migration.md
44-
[Custom theme integration]: custom-themes.md
4546
[Third-party content type migration]: new-content-type-example.md
4647
[Iconography]: iconography.md
4748
[Add image uploader to content type]: image-uploader.md
@@ -60,7 +61,7 @@ It replaces the default WYSIWYG Editor in the Admin area with a highly configura
6061
[Render a backend content type preview]: content-type-preview.md
6162
[Custom Toolbar]: toolbar.md
6263
[Full width page layouts]: full-width-page-layouts.md
63-
[Add custom logic to content types]: add-custom-logic.md
64+
[Add image uploader to content type]: image-uploader.md
6465
[Roadmap and Known Issues]: roadmap.md
6566
[How to create custom PageBuilder content type container]: how-to-create-custom-content-type-container.md
66-
<!--{% endcomment %}-->
67+
<!-- {% endcomment %} -->

0 commit comments

Comments
 (0)