Skip to content

Commit eb53a2b

Browse files
author
James Calcaben
committed
MAGETWO-91200: Update documentation for PageBuilder EAP
- Revise README.md draft
1 parent 21e49bb commit eb53a2b

File tree

1 file changed

+48
-22
lines changed

1 file changed

+48
-22
lines changed

README.md

Lines changed: 48 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,57 @@
11
# magento2-page-builder
22

3-
# PageBuilder EAP
3+
## PageBuilder Early Access Program
44

5-
We open access to PageBuilder code for Partners to:
6-
- explore extension points that PageBuilder provides in oder to build integration with native PageBuilder capabilities for 3rd parties (Facebook, Instagram etc) and their own modules
7-
- try out PageBuilder customization options to grow its functionality beyond native features
8-
- Prepare to migrate clients from Bluefoot 1.0 to PageBuilder
5+
The PageBuilder Early Access Program (EAP) gives partners the following perks:
96

10-
This program is _not design_ to build a website and go live using early code.
7+
* Explore PageBuilder extension points to build custom modules and integrations for 3rd party services, such as Facebook, Instagram, etc.
8+
* Try out PageBuilder customization options and extend its functionality beyond its default features.
9+
* Preview PageBuilder to prepare a migration plan from BlueFoot 1.0 to PageBuilder.
10+
11+
**Note:**
12+
*This program should not be used to design and launch a production website using early code.*
1113

12-
# PageBuilder Package
13-
We offer 2 options to get the PageBuilder code:
14-
- Composer package - option for installing page builder if you do not plan to do any contribution into PageBuilder code repository
15-
- GitHub repository - option to install page builder and contribute to the code
14+
## Installation
1615

17-
# Contribution to the PageBuilder
18-
We appreciate your direct contribution to PageBuilder repo. It can be either feature development or bug fix:
19-
List of known issues
16+
We offer two methods for installing PageBuilder:
2017

21-
# PageBuilder Updates from Magento Core Team
22-
Expect the code to be updated on regular basis (every 2 weeks) and be ready to the update introducing breaking changes. We want to limit that harm so we publish the backlog that core teams are going to work on next couple of months:
23-
link to the list of features
18+
* As a [Composer package] - use this option if you do not plan to contribute to the PageBuilder code repository
19+
* Using the [GitHub repository] - use this option to install PageBuilder from the GitHub repository and contribute to the code
2420

25-
# Feedback needed
26-
We want to know more how you would need to customize PageBuilder. Here is the list of topics that we are specifically interested in:
27-
Web Content API
21+
[Composer package]: app/code/Magento/PageBuilder/docs/install.md#composer-installation
22+
[GitHub repository]: app/code/Magento/PageBuilder/docs/install.md#github-installation
2823

29-
Join the PageBuilder slack channel to participate in technical discussions and ask questions
30-
URL: magentocommeng.slack.com
31-
And ping Olena Tkacheva (https://magentocommeng.slack.com/messages/@UAFV915FB)
24+
## Contribute to PageBuilder
25+
26+
We appreciate any and all contributions to PageBuilder.
27+
A good place to start is by looking at our [features roadmap] and list of [known issues].
28+
29+
If you are interested in contributing to this repository, please see our [Contribution Guide].
30+
31+
[Contribution Guide]: app/code/Magento/PageBuilder/docs/CONTRIBUTING.md
32+
[features roadmap]: app/code/Magento/PageBuilder/docs/roadmap.md#planned-features-and-functionality
33+
[known issues]: app/code/Magento/PageBuilder/docs/roadmap.md#known-issues
34+
35+
## PageBuilder updates from the Magento core team
36+
37+
The PageBuilder team updates the code every 2 weeks.
38+
**These changes may introduce breaking changes.**
39+
40+
To help you prepare for these changes, we are publishing a [roadmap] of features and issues that we are going to work on in the following months.
41+
42+
[roadmap]: app/code/Magento/PageBuilder/docs/roadmap.md
43+
44+
## Provide feedback
45+
46+
We want to hear what you think of PageBuilder!
47+
We are particularly interested on your thoughts on the following:
48+
49+
* How would you customize PageBuilder and what do you need to accomplish this task?
50+
* What web content API do you use or would like to see in PageBuilder?
51+
52+
To participate in technical discussions and ask questions, join us in [Slack].
53+
54+
For all other questions or requests, contact [Olena Tkacheva].
55+
56+
[Slack]: https://magentocommeng.slack.com/
57+
[Olena Tkacheva]: https://magentocommeng.slack.com/messages/@UAFV915FB

0 commit comments

Comments
 (0)