Merge pull request #56 from magento-obsessive-owls/MAGETWO-91200-update-documentation-eap

[CMS Team 2 - Sprint 8] Update documentation for EAP, fix data migration

Author: Igor Melnikov

README.md

@@ -0,0 +1,85 @@
+# magento2-page-builder
+
+## PageBuilder Early Access Program
+
+The PageBuilder Early Access Program (EAP) gives partners the following perks:
+
+* Explore PageBuilder extension points to build custom modules and integrations for 3rd party services, such as Facebook, Instagram, etc.
+* Try out PageBuilder customization options and extend its functionality beyond its default features.
+* Preview PageBuilder to prepare a migration plan from BlueFoot 1.0 to PageBuilder.
+ 
+**Note:**
+*This program should not be used to design and launch a production website using early code.*
+
+## Installation
+
+We offer two methods for installing PageBuilder:
+
+* As a [Composer package] - use this option if you do not plan to contribute to the PageBuilder code repository 
+* Using the [GitHub repository] - use this option to install PageBuilder from the GitHub repository and contribute to the code 
+
+[Composer package]: app/code/Magento/PageBuilder/docs/install.md#composer-installation
+[GitHub repository]: app/code/Magento/PageBuilder/docs/install.md#github-installation
+
+## Developer documentation
+
+This project repository contains PageBuilder developer documentation on the following topics:
+
+1. [Architecture overview]
+1. [BlueFoot to PageBuilder data migration]
+1. [Third-party content type migration]
+1. [Iconography]
+1. [Module integration]
+1. [Additional data configuration]
+1. [Content type configuration]
+1. [How to add a new content type]
+1. [Events]
+1. [Master format]
+1. [Visual select]
+
+[Architecture overview]: app/code/Magento/PageBuilder/docs/architecture-overview.md
+[BlueFoot to PageBuilder data migration]: app/code/Magento/PageBuilder/docs/bluefoot-data-migration.md
+[Third-party content type migration]: app/code/Magento/PageBuilder/docs/new-content-type-example.md
+[Iconography]: app/code/Magento/PageBuilder/docs/iconography.md
+[Module integration]: app/code/Magento/PageBuilder/docs/module-integration.md
+[Additional data configuration]: app/code/Magento/PageBuilder/docs/custom-configuration.md
+[Content type configuration]: app/code/Magento/PageBuilder/docs/content-type-configuration.md
+[How to add a new content type]: app/code/Magento/PageBuilder/docs/how-to-add-new-content-type.md
+[Events]: app/code/Magento/PageBuilder/docs/events.md
+[Master format]: app/code/Magento/PageBuilder/docs/master-format.md
+[Visual select]: app/code/Magento/PageBuilder/docs/visual-select.md
+
+## Contribute to PageBuilder
+
+We appreciate any and all contributions to PageBuilder. 
+A good place to start is by looking at our [features roadmap] and list of [known issues].
+
+If you are interested in contributing to this repository, please see our [Contribution Guide].
+
+[Contribution Guide]: app/code/Magento/PageBuilder/docs/CONTRIBUTING.md
+[features roadmap]: app/code/Magento/PageBuilder/docs/roadmap.md#planned-features-and-functionality
+[known issues]: app/code/Magento/PageBuilder/docs/roadmap.md#known-issues
+
+## PageBuilder updates from the Magento core team
+
+The PageBuilder team updates the code every 2 weeks.
+**These changes may introduce breaking changes.**
+
+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.
+
+[roadmap]: app/code/Magento/PageBuilder/docs/roadmap.md
+
+## Provide feedback
+
+We want to hear what you think of PageBuilder!
+We are particularly interested on your thoughts on the following:
+
+* [How would you customize PageBuilder and what do you need to accomplish this task?](https://github.com/magento/magento2-page-builder/issues/57)
+* [What web content API do you use or would like to see in PageBuilder?](https://github.com/magento/magento2-page-builder/issues/58)
+
+To participate in technical discussions and ask questions, join us in [Slack].
+
+For all other questions or requests, contact [Olena Tkacheva].
+
+[Slack]: https://magentocommeng.slack.com/
+[Olena Tkacheva]: https://magentocommeng.slack.com/messages/@UAFV915FB

app/code/Magento/PageBuilder/Setup/DataConverter/Renderer/AdvancedSliderItem.php

@@ -75,13 +75,15 @@ public function render(array $itemData, array $additionalData = [])
         $overlayDivElementAttributes['class'] = 'pagebuilder-overlay pagebuilder-poster-overlay';
         $style = $this->styleExtractor->extractStyle($formData, ['padding']);
 
+        $overlayColor = 'transparent';
         if (isset($eavData['has_overlay']) && $eavData['has_overlay'] == 1) {
-            $overlayDivElementAttributes['data-overlay-color'] = 'rgba(0,0,0,0.5)';   // default overlay style
+            $overlayColor = 'rgba(0,0,0,0.5)';
             if ($style) {
                 $style .= ' ';
             }
             $style .= 'background-color: rgba(0,0,0,0.5);';
         }
+        $overlayDivElementAttributes['data-overlay-color'] = $overlayColor;
         if ($style) {
             $overlayDivElementAttributes['style'] = $style;
         }

app/code/Magento/PageBuilder/Setup/DataConverter/Renderer/SliderItem.php

@@ -29,21 +29,29 @@ class MigrateToPageBuilder implements DataPatchInterface
      */
     private $moveImages;
 
+    /**
+     * @var \Magento\Framework\App\State
+     */
+    private $appState;
+
     /**
      * Constructor
      *
      * @param \Magento\PageBuilder\Setup\ConvertBlueFootToPageBuilderFactory $convertBlueFootToPageBuilderFactory
      * @param ModuleDataSetupInterface $moduleDataSetup
      * @param MoveImages $moveImages
+     * @param \Magento\Framework\App\State $appState
      */
     public function __construct(
         \Magento\PageBuilder\Setup\ConvertBlueFootToPageBuilderFactory $convertBlueFootToPageBuilderFactory,
         ModuleDataSetupInterface $moduleDataSetup,
-        MoveImages $moveImages
+        MoveImages $moveImages,
+        \Magento\Framework\App\State $appState
     ) {
         $this->convertBlueFootToPageBuilderFactory = $convertBlueFootToPageBuilderFactory;
         $this->moduleDataSetup = $moduleDataSetup;
         $this->moveImages = $moveImages;
+        $this->appState = $appState;
     }
 
     /**
@@ -55,7 +63,13 @@ public function apply()
     {
         if ($this->moduleDataSetup->tableExists('gene_bluefoot_entity')) {
             $this->updateEavConfiguration();
-            $this->convertBlueFootToPageBuilderFactory->create(['setup' => $this->moduleDataSetup])->convert();
+            $convertBlueFootToPageBuilder = $this->convertBlueFootToPageBuilderFactory->create(
+                ['setup' => $this->moduleDataSetup]
+            );
+            $this->appState->emulateAreaCode(
+                \Magento\Framework\App\Area::AREA_ADMINHTML,
+                [$convertBlueFootToPageBuilder, 'convert']
+            );
             $this->moveImages->move();
         }
     }

app/code/Magento/PageBuilder/Setup/Patch/Data/MigrateToPageBuilder.php

@@ -0,0 +1,68 @@
+# Contributing to Magento 2 code
+
+## Navigation
+
+1. [Introduction]
+2. [Installation guide]
+3. **Contribution guide**
+    1. [Overview](#overview)
+    1. [Contribution requirements](#contribution-requirements)
+    1. [Contribution process](#contribution-process)
+    1. [Code of Conduct](#code-of-conduct)
+4. [Developer documentation]
+5. [Roadmap and known issues]
+
+[Introduction]: README.md
+[Installation Guide]: install.md
+[Contribution guide]: CONTRIBUTING.md
+[Developer documentation]: developer-documentation.md
+[Architecture overview]: architecture-overview.md
+[BlueFoot to PageBuilder data migration]: bluefoot-data-migration.md
+[Third-party content type migration]: new-content-type-example.md
+[Iconography]: iconography.md
+[Module integration]: module-integration.md
+[Additional data configuration]: custom-configuration.md
+[Content type configuration]: content-type-configuration.md
+[How to add a new content type]: how-to-add-new-content-type.md
+[Events]: events.md
+[Master format]: master-format.md
+[Visual select]: visual-select.md
+[Roadmap and Known Issues]: roadmap.m
+
+## Overview
+
+Contributions to the Magento 2 codebase are done using the fork & pull model.
+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”).
+
+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.
+
+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.
+
+
+## Contribution requirements
+
+1. Contributions must adhere to [Magento coding standards](http://devdocs.magento.com/guides/v2.0/coding-standards/bk-coding-standards.html).
+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.
+3. Commits must be accompanied by meaningful commit messages.
+4. PRs which include bug fixing, must be accompanied with step-by-step description of how to reproduce the bug.
+3. PRs which include new logic or new features must be submitted along with:
+* Unit/integration test coverage where applicable.
+* Updated documentation in the module directory `app/code/PageBuilder/docs`.
+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.
+5. All automated tests are passed successfully locally. After PR submitted Magento team will run builds on continuous integration environment.
+
+## Contribution process
+
+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”.
+
+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.
+2. Please contact us in Slack chanel if you want to work on issue from [list of known issues](roadmap.md#Known Issues).
+2. Review the [Contributor License Agreement](https://magento.com/legaldocuments/mca) if this is your first time contributing.
+3. Create and test your work.
+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`.
+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.
+
+## Code of Conduct
+
+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.
+The full text is available in the repository [Wiki](https://github.com/magento/magento2/wiki/Magento-Code-of-Conduct).

app/code/Magento/PageBuilder/docs/CONTRIBUTING.md

@@ -0,0 +1,40 @@
+# PageBuilder Module Documentation
+
+PageBuilder is a Content Management System(CMS) module for Magento 2.3 and above.
+It replaces the default WYSIWYG Editor in the Admin area with a highly configurable drag-and-drop editing system.
+
+## Navigation
+
+1. **Introduction**
+2. [Installation guide]
+3. [Contribution guide]
+4. [Developer documentation]
+    1. [Architecture overview]
+    1. [BlueFoot to PageBuilder data migration]
+    1. [Third-party content type migration]
+    1. [Iconography]
+    1. [Module integration]
+    1. [Additional data configuration]
+    1. [Content type configuration]
+    1. [How to add a new content type]
+    1. [Events]
+    1. [Master format]
+    1. [Visual select]
+5. [Roadmap and known issues]
+
+[Introduction]: README.md
+[Installation Guide]: install.md
+[Contribution guide]: CONTRIBUTING.md
+[Developer documentation]: developer-documentation.md
+[Architecture overview]: architecture-overview.md
+[BlueFoot to PageBuilder data migration]: bluefoot-data-migration.md
+[Third-party content type migration]: new-content-type-example.md
+[Iconography]: iconography.md
+[Module integration]: module-integration.md
+[Additional data configuration]: custom-configuration.md
+[Content type configuration]: content-type-configuration.md
+[How to add a new content type]: how-to-add-new-content-type.md
+[Events]: events.md
+[Master format]: master-format.md
+[Visual select]: visual-select.md
+[Roadmap and Known Issues]: roadmap.md