Skip to content

Commit 774f786

Browse files
committed
MC-20116: DOCS release notes
1 parent bd39126 commit 774f786

File tree

3 files changed

+76
-4
lines changed

3 files changed

+76
-4
lines changed

docs/contribution-guide.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing to Magento 2 code
2+
3+
## Overview
4+
5+
Contributions to the Magento 2 codebase are done using the fork & pull model.
6+
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”).
7+
8+
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.
9+
10+
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.
11+
12+
## Contribution requirements
13+
14+
1. Contributions must adhere to [Magento coding standards](http://devdocs.magento.com/guides/v2.0/coding-standards/bk-coding-standards.html).
15+
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.
16+
3. Commits must be accompanied by meaningful commit messages.
17+
4. PRs which include bug fixing, must be accompanied with step-by-step description of how to reproduce the bug.
18+
5. PRs which include new logic or new features must be submitted along with:
19+
* Unit/integration test coverage where applicable.
20+
* Updated documentation in the `docs` directory at the root level.
21+
6. 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.
22+
7. All automated tests are passed successfully locally. After PR submitted Magento team will run builds on continuous integration environment.
23+
24+
## Contribution process
25+
26+
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”.
27+
28+
1. Search current [listed issues](https://github.com/magento/magento2-page-builder/issues) on GitHub (open or closed) before starting work on a new contribution.
29+
2. Review the [Contributor License Agreement](https://magento.com/legaldocuments/mca) if this is your first time contributing.
30+
3. Create and test your work.
31+
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`.
32+
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.
33+
34+
## Code of Conduct
35+
36+
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.
37+
The full text is available in the repository [Wiki](https://github.com/magento/magento2/wiki/Magento-Code-of-Conduct).

docs/create-custom-content-type/step-1-add-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Files referenced from the configuration include the HTML templates, the JavaScri
88

99
## Configuration conventions
1010

11-
By convention, Page Builder requires the configuration file to be in the `<module_name>/adminhtml/pagebuilder/content_type` or `content-type` directory.
11+
By convention, Page Builder requires the configuration file to be in the `<module_name>/view/adminhtml/pagebuilder/content_type` or `content-type` directory.
1212

1313
The name of your configuration file should reflect the name of your content type prefixed by your module vendor name and separated by an underscore (_). For example, our module name is `Example/PageBuilderQuote` and our content type is a quote control, so we name our configuration file `example_quote.xml` and add it to our module within the following directory structure (`view/adminhtml/pagebuilder/content_type/`):
1414

docs/release-notes.md

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,47 @@
1-
# Page Builder release notes
1+
# Release note for Page Builder
2+
3+
The following updates describe the latest improvements to Page Builder.
4+
5+
The release notes include:
6+
7+
- {:.new}New features
8+
- {:.fix}Fixes and improvements
9+
10+
## 1.1.0
11+
12+
- {:.new}<!-- MC-15250 -->Added explicit product sorting to the Products content type.
13+
14+
- {:.new}<!-- MC-17823 -->Added buttons for inserting images, widgets, and variables in the HTML content type.
15+
16+
- {:.new}<!-- MC-1805 -->Upgraded Page Builder to PHP version 7.3.
17+
18+
- {:.fix}<!-- MC-3880 -->Fixed an issue in which the minimum height & vertical alignment was inconsistent between sections On the edit panel for each content type.
19+
20+
- {:.fix}<!-- MC-4137 -->Fixed several TinyMCE inline editor issues. Variables, images, & image links now get added where cursor is placed; tables and table cells can now be center aligned; copy/paste pastes content at the cursor's position; links can now be applied to selected text; bullets are now properly aligned; editor changes are now saved without first clicking outside the editor.
21+
22+
- {:.fix}<!-- MC-14994 -->Fixed an issue in which the toolbar from the Heading content type was positioned incorrectly when first dropped on the stage.
23+
24+
- {:.fix}<!-- MC-15742 -->Removed the hard-coded 35px from the bottom of the Slider content type.
25+
26+
- {:.fix}<!-- MC-15812 -->Removed the hard-code 5px from the bottom of the Video content type.
27+
28+
- {:.fix}<!-- MC-16241 -->Fixed an issue in which the required asterisk symbol was displayed twice on form fields.
29+
30+
- {:.fix}<!-- MC-18799 -->Restricted Page Builder 1.1.0 to Magento 2.3.3+.
31+
32+
## 1.0.2
33+
34+
- {:.fix}<!-- MC-18723 -->Restricted Page Builder 1.0.2 to Magento 2.3.2.1+.
35+
36+
- {:.fix}<!-- MC-19192 -->Backported Page Builder TinyMCE performance fix from 1.1.0-release.
237

338
## 1.0.1
439

5-
- Ensures compatibility with Magento Commerce 2.3.2.
40+
- {:.fix}Ensures compatibility with Magento Commerce 2.3.2.
641

742
## 1.0.0
843

9-
- General availability release!
44+
- {:.new}General availability release!
1045

1146
### Documentation
1247

0 commit comments

Comments
 (0)