Skip to content

Commit 55bb8e6

Browse files
bdenhambdenham
authored
Merge pull request #2 from magento-devdocs/MC-5710
MC-5710: Beta docs tutorial
2 parents aa69501 + 7bdba98 commit 55bb8e6

Some content is hidden

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

45 files changed

+721
-490
lines changed

‎README.md

+12-97
Original file line numberDiff line numberDiff line change
@@ -1,113 +1,28 @@
1-
# magento2-page-builder
2-
3-
<!-- {% raw %} -->
4-
51
## PageBuilder Early Access Program
62

7-
The PageBuilder Early Access Program (EAP) gives partners the following perks:
8-
9-
* Explore PageBuilder extension points to build custom modules and integrations for 3rd party services, such as Facebook, Instagram, etc.
10-
* Try out PageBuilder customization options and extend its functionality beyond its default features.
11-
* Preview PageBuilder to prepare a migration plan from BlueFoot 1.0 to PageBuilder.
12-
13-
**Note:**
14-
*This program should not be used to design and launch a production website using early code.*
15-
16-
## Installation
17-
18-
We offer one method for installing PageBuilder:
19-
20-
* Using the [GitHub repository] - use this option to install PageBuilder from the GitHub repository and contribute to the code.
21-
22-
[GitHub repository]: docs/install-pagebuilder.md
23-
24-
<!-- {% comment %} -->
3+
The Page Builder Early Access Program (EAP) gives partners the following perks:
4+
5+
* Explore extension points to build custom modules and integrations for 3rd party services, such as Facebook and Instagram.
6+
* Try out customization options and extend its functionality beyond its default features.
7+
* Preview to prepare a migration plan from BlueFoot 1.0 to PageBuilder.
258

269
## Developer documentation
2710

28-
### Getting Started
29-
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)
61-
62-
### How Tos
63-
64-
* [How to develop a new content type](docs/how-to/how-to-develop-new-content-type.md)
65-
* [How to develop a container content type](docs/how-to/how-to-develop-container-content-type.md)
66-
* [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)
68-
* [How to add inline text editing](docs/how-to/how-to-add-inline-text-editing.md)
69-
* [How to add a custom toolbar](docs/how-to/how-to-add-custom-toolbar.md)
70-
* [How to convert product attribute fields to use Page Builder](docs/how-to/how-to-convert-product-attributes-to-use-pagebuilder.md)
71-
* [How to store a component master format as a widget-directive](docs/how-to/how-to-store-master-format-as-widget-directive.md)
72-
73-
### Reference
74-
75-
* [Architecture](docs/reference/architecture.md)
76-
* [Events](docs/reference/events.md)
77-
* [Knockout bindings](docs/reference/knockout-bindings.md)
78-
* [Master format](docs/reference/master-format.md)
79-
80-
### Migration
81-
82-
* [Migrate from BlueFoot](docs/migration/migrate-from-bluefoot.md)
83-
* [Migrate custom content types from BlueFoot](docs/migration/migrate-custom-content-types-from-bluefoot.md)
84-
85-
<!-- {% endcomment %} -->
11+
We will update the developer documentation frequently during beta. Please use this link to access the latest updates: 
12+
[Page Builder developer documentation](https://devdocs.magedevteam.com/ds_pagebuilder/page-builder/getting-started/introduction.html)
8613

8714
## Contribute to PageBuilder
8815

8916
We appreciate any and all contributions to PageBuilder. If you are interested in contributing to this repository, please see our [Contribution Guide].
9017

91-
[Contribution Guide]: CONTRIBUTING.md
92-
9318
## PageBuilder updates from the Magento core team
9419

95-
The PageBuilder team updates the code every 2 weeks.
96-
**These changes may introduce breaking changes.**
97-
98-
## Provide feedback
20+
We will push new beta releases once a week, including work from the backlog. We don't expect any large breaking changes, but we will communicate them to you if the need arises.
9921

100-
We want to hear what you think of PageBuilder!
101-
We are particularly interested on your thoughts on the following:
22+
## Contact us
10223

103-
* [How would you customize PageBuilder and what do you need to accomplish this task?](https://github.com/magento/magento2-page-builder/issues/57)
104-
* [What web content API do you use or would like to see in PageBuilder?](https://github.com/magento/magento2-page-builder/issues/58)
24+
To participate in technical discussions and ask questions, join us in [Slack], where a number of Page Builder team members are present.
10525

106-
To participate in technical discussions and ask questions, join us in [Slack].
10726

108-
For all other questions or requests, contact [Olena Tkacheva].
109-
110-
[Slack]: https://magentocommeng.slack.com/
111-
[Olena Tkacheva]: https://magentocommeng.slack.com/messages/@UAFV915FB
112-
113-
<!-- {% endraw %} -->
27+
[Contribution Guide]: CONTRIBUTING.md
28+
[Slack]: https://magentocommeng.slack.com/messages/GANS1R4C9

‎docs/CONTRIBUTING.md

+37
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/_pagebuilder.yml

+17-17
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
label: Page Builder
22
pages:
3-
- label: Getting Started
3+
- label: Getting started
44
url: /page-builder/getting-started/introduction.html
55
versionless: true
66
children:
@@ -35,20 +35,16 @@ pages:
3535
url: /page-builder/create-basic-content-type/step-3-add-components.html
3636
versionless: true
3737

38-
- label: Step 4. Add form editor
39-
url: /page-builder/create-basic-content-type/step-4-add-form-editor.html
38+
- label: Step 4. Add form
39+
url: /page-builder/create-basic-content-type/step-4-add-form.html
4040
versionless: true
4141

42-
- label: Step 5. Add layout
43-
url: /page-builder/create-basic-content-type/step-5-add-layout.html
42+
- label: Step 5. Add styles
43+
url: /page-builder/create-basic-content-type/step-5-add-styles.html
4444
versionless: true
4545

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
46+
- label: Step 6. Add frontend widget
47+
url: /page-builder/create-basic-content-type/step-6-add-frontend-widget.html
5248
versionless: true
5349

5450
- label: What's next?
@@ -106,7 +102,7 @@ pages:
106102
url: /page-builder/configurations/server-side-rendered-previews.html
107103
versionless: true
108104

109-
- label: How Tos
105+
- label: How tos
110106
versionless: true
111107
children:
112108
- label: How to develop a new content type
@@ -167,10 +163,14 @@ pages:
167163
url: /page-builder/migration/migrate-custom-content-types-from-bluefoot.html
168164
versionless: true
169165

170-
- label: Contribution guide
171-
url: /page-builder/CONTRIBUTING.html
166+
- label: Component status
167+
url: /page-builder/component-status.html
172168
versionless: true
173169

174-
# - label: Roadmap and Known Issues
175-
# url: /page-builder/roadmap.html
176-
# versionless: true
170+
- label: Known issues
171+
url: /page-builder/known-issues.html
172+
versionless: true
173+
174+
- label: Contribution guide
175+
url: https://github.com/magento/magento2-page-builder/blob/develop/CONTRIBUTING.md
176+
versionless: true

‎docs/component-status.md

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Component status
2+
3+
**Last Updated: November 27, 2018**
4+
5+
<style type="text/css" style="display: none">
6+
.status {
7+
padding: 3px 5px;
8+
border-radius: 2px;
9+
}
10+
.status.red {
11+
color: #fff;
12+
background-color: #d04437;
13+
}
14+
.status.yellow {
15+
background-color: #f6c342;
16+
}
17+
.status.green {
18+
background-color: #14892c;
19+
color: #fff;
20+
}
21+
</style>
22+
23+
This page shows the status of each content type and component in Page Builder beta as a measure of readiness for each.
24+
25+
Each status color indicates the severity and number of issues for a particular component.
26+
27+
- <span class="status red">Red</span> - The content type or component has critical and blocking issues that make this module unstable.
28+
- <span class="status yellow">Yellow</span> - The content type or component has some issues that may cause problems, but it is still functional.
29+
- <span class="status green">Green</span> - The content type or component has no significant or outstanding issues.
30+
31+
The issues used to generate the status of these components come from verified internal and GitHub reports for Page Builder beta.
32+
Issues that are not related to Page Builder beta are not part of this report.
33+
34+
## Content Types
35+
36+
| Name | Status | Notes |
37+
| ------------------ | ----------------------------------------- | ----------------------------------------- |
38+
| Row | <span class='status green'>Green</span> | |
39+
| Column | <span class='status green'>Green</span> | |
40+
| Tabs | <span class='status green'>Green</span> | |
41+
| Text | <span class='status green'>Green</span> | |
42+
| Heading | <span class='status green'>Green</span> | |
43+
| Buttons | <span class='status green'>Green</span> | |
44+
| Divider | <span class='status green'>Green</span> | |
45+
| HTML Code | <span class='status green'>Green</span> | |
46+
| Image | <span class='status green'>Green</span> | |
47+
| Video | <span class='status green'>Green</span> | |
48+
| Banner | <span class='status green'>Green</span> | |
49+
| Slider | <span class='status yellow'>Yellow</span> | Cannot be edited in IE 11 |
50+
| Map | <span class='status green'>Green</span> | |
51+
| Block | <span class='status green'>Green</span> | |
52+
| Dynamic Block | <span class='status green'>Green</span> | |
53+
| Products | <span class='status green'>Green</span> | |
54+
{:style="table-layout:auto"}
55+
56+
## Migration
57+
58+
| Name | Status | Notes |
59+
| --------------------------------- | --------------------------------------- | ----------------------|
60+
| Bluefoot to Page Builder | <span class='status red'>Red</span> | The renderers provided out of the box are not fully updated with the latest changes to their respective content types.|
61+
{:style="table-layout:auto"}

0 commit comments

Comments
 (0)