Merge pull request #2 from magento-devdocs/MC-5710

MC-5710: Beta docs tutorial

Author: bdenham

README.md

@@ -1,113 +1,28 @@
-# magento2-page-builder
-
-<!-- {% raw %} -->
-
 ## 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 one method for installing PageBuilder:
-
-* Using the [GitHub repository] - use this option to install PageBuilder from the GitHub repository and contribute to the code.
-
-[GitHub repository]: docs/install-pagebuilder.md
-
-<!-- {% comment %} -->
+The Page Builder Early Access Program (EAP) gives partners the following perks:
+ 
+* Explore extension points to build custom modules and integrations for 3rd party services, such as Facebook and Instagram.
+* Try out customization options and extend its functionality beyond its default features.
+* Preview to prepare a migration plan from BlueFoot 1.0 to PageBuilder.
 
 ## Developer documentation
 
-### Getting Started
-
-* [Introduction](docs/getting-started/introduction.md)
-* [Install Page Builder](docs/getting-started/install-pagebuilder.md)
-* [Activate Page Builder](docs/getting-started/activate-pagebuilder.md)
-* [View Page Builder](docs/getting-started/view-pagebuilder.md)
-
-### Create a content type
-
-* [Overview](docs/create-basic-content-type/overview.md)
-* [Step 1: Add configuration](docs/create-basic-content-type/step-1-add-configuration.md)
-* [Step 2: Add templates](docs/create-basic-content-type/step-2-add-templates.md)
-* [Step 3: Add components](docs/create-basic-content-type/step-3-add-components.md)
-* [Step 4: Add form editor](docs/create-basic-content-type/step-4-add-form-editor.md)
-* [Step 5: Add layout](docs/create-basic-content-type/step-5-add-layout.md)
-* [Step 6: Add styles and icons](docs/create-basic-content-type/step-6-add-styles-icons.md)
-* [Step 7: Add frontend widget](docs/create-basic-content-type/step-7-add-frontend-widget.md)
-* [What's next](docs/create-basic-content-type/whats-next.md)
-
-### Configurations
-
-* [Main configurations](docs/configurations/content-type-configuration.md)
-* [Additional configurations](docs/configurations/additional-configurations.md)
-* [Panel configurations](docs/configurations/panel-configurations.md)
-* [Option menu configurations](docs/configurations/option-menu-configurations.md)
-* [Iconography](docs/configurations/iconography.md)
-* [Block chooser configuration](docs/configurations/block-chooser-configuration.md)
-* [Full-width page layout configuration](docs/configurations/full-width-page-layout-configuration.md)
-* [Responsive layout configuration](docs/configurations/responsive-layout-configuration.md)
-* [Storefront configuration](docs/configurations/storefront-configuration.md)
-* [Selector configuration](docs/configurations/selector-configuration.md)
-* [Product conditions configuration](docs/configurations/product-conditions-configuration.md)
-* [Server-side rendered previews](docs/configurations/server-side-rendered-previews.md)
-
-### How Tos
-
-* [How to develop a new content type](docs/how-to/how-to-develop-new-content-type.md)
-* [How to develop a container content type](docs/how-to/how-to-develop-container-content-type.md)
-* [How to use the Image Uploader](docs/how-to/how-to-use-image-uploader.md)
-* [How to use the Image Uploader](docs/how-to/how-to-use-image-uploader.md)
-* [How to add inline text editing](docs/how-to/how-to-add-inline-text-editing.md)
-* [How to add a custom toolbar](docs/how-to/how-to-add-custom-toolbar.md)
-* [How to convert product attribute fields to use Page Builder](docs/how-to/how-to-convert-product-attributes-to-use-pagebuilder.md)
-* [How to store a component master format as a widget-directive](docs/how-to/how-to-store-master-format-as-widget-directive.md)
-
-### Reference
-
-* [Architecture](docs/reference/architecture.md)
-* [Events](docs/reference/events.md)
-* [Knockout bindings](docs/reference/knockout-bindings.md)
-* [Master format](docs/reference/master-format.md)
-
-### Migration
-
-* [Migrate from BlueFoot](docs/migration/migrate-from-bluefoot.md)
-* [Migrate custom content types from BlueFoot](docs/migration/migrate-custom-content-types-from-bluefoot.md)
-  
-<!-- {% endcomment %} -->
+We will update the developer documentation frequently during beta. Please use this link to access the latest updates: 
+[Page Builder developer documentation](https://devdocs.magedevteam.com/ds_pagebuilder/page-builder/getting-started/introduction.html)
 
 ## Contribute to PageBuilder
 
 We appreciate any and all contributions to PageBuilder. If you are interested in contributing to this repository, please see our [Contribution Guide].
 
-[Contribution Guide]: CONTRIBUTING.md
-
 ## PageBuilder updates from the Magento core team
 
-The PageBuilder team updates the code every 2 weeks.
-**These changes may introduce breaking changes.**
-
-## Provide feedback
+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.
 
-We want to hear what you think of PageBuilder!
-We are particularly interested on your thoughts on the following:
+## Contact us
 
-* [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], where a number of Page Builder team members are present.
 
-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
-
-<!-- {% endraw %} -->
+[Contribution Guide]: CONTRIBUTING.md
+[Slack]: https://magentocommeng.slack.com/messages/GANS1R4C9

docs/CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# Contributing to Magento 2 code
+
+## 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.
+5. PRs which include new logic or new features must be submitted along with:
+    * Unit/integration test coverage where applicable.
+    * Updated documentation in the `docs` directory at the root level.
+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.
+7. 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) before starting work on a new contribution.
+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).

docs/_pagebuilder.yml

@@ -1,6 +1,6 @@
 label: Page Builder
 pages:
-- label: Getting Started
+- label: Getting started
   url: /page-builder/getting-started/introduction.html
   versionless: true
   children:
@@ -35,20 +35,16 @@ pages:
     url: /page-builder/create-basic-content-type/step-3-add-components.html
     versionless: true
 
-  - label: Step 4. Add form editor
-    url: /page-builder/create-basic-content-type/step-4-add-form-editor.html
+  - label: Step 4. Add form
+    url: /page-builder/create-basic-content-type/step-4-add-form.html
     versionless: true
 
-  - label: Step 5. Add layout
-    url: /page-builder/create-basic-content-type/step-5-add-layout.html
+  - label: Step 5. Add styles
+    url: /page-builder/create-basic-content-type/step-5-add-styles.html
     versionless: true
 
-  - label: Step 6. Add styles and icons
-    url: /page-builder/create-basic-content-type/step-6-add-styles-icons.html
-    versionless: true
-
-  - label: Step 7. Add frontend widget
-    url: /page-builder/create-basic-content-type/step-7-add-frontend-widget.html
+  - label: Step 6. Add frontend widget
+    url: /page-builder/create-basic-content-type/step-6-add-frontend-widget.html
     versionless: true
 
   - label: What's next?
@@ -106,7 +102,7 @@ pages:
     url: /page-builder/configurations/server-side-rendered-previews.html
     versionless: true
 
-- label: How Tos
+- label: How tos
   versionless: true
   children:
   - label: How to develop a new content type
@@ -167,10 +163,14 @@ pages:
     url: /page-builder/migration/migrate-custom-content-types-from-bluefoot.html
     versionless: true
 
-- label: Contribution guide
-  url: /page-builder/CONTRIBUTING.html
+- label: Component status
+  url: /page-builder/component-status.html
   versionless: true
 
-# - label: Roadmap and Known Issues
-#   url: /page-builder/roadmap.html
-#   versionless: true
+- label: Known issues
+  url: /page-builder/known-issues.html
+  versionless: true
+
+- label: Contribution guide
+  url: https://github.com/magento/magento2-page-builder/blob/develop/CONTRIBUTING.md
+  versionless: true

docs/component-status.md

@@ -0,0 +1,61 @@
+# Component status
+
+**Last Updated: November 27, 2018**
+
+<style type="text/css" style="display: none">
+.status {
+  padding: 3px 5px;
+  border-radius: 2px;
+}
+.status.red {
+  color: #fff;
+  background-color: #d04437;
+}
+.status.yellow {
+  background-color: #f6c342;
+}
+.status.green {
+  background-color: #14892c;
+  color: #fff;
+}
+</style>
+
+This page shows the status of each content type and component in Page Builder beta as a measure of readiness for each.
+
+Each status color indicates the severity and number of issues for a particular component.
+
+- <span class="status red">Red</span> - The content type or component has critical and blocking issues that make this module unstable.
+- <span class="status yellow">Yellow</span> - The content type or component has some issues that may cause problems, but it is still functional.
+- <span class="status green">Green</span> - The content type or component has no significant or outstanding issues.
+
+The issues used to generate the status of these components come from verified internal and GitHub reports for Page Builder beta.
+Issues that are not related to Page Builder beta are not part of this report.
+
+## Content Types
+
+| Name               | Status                                    | Notes                                     |
+| ------------------ | ----------------------------------------- | ----------------------------------------- |
+| Row                | <span class='status green'>Green</span>   |  |
+| Column             | <span class='status green'>Green</span>   |  |
+| Tabs               | <span class='status green'>Green</span>   |  |
+| Text               | <span class='status green'>Green</span>   |  |
+| Heading            | <span class='status green'>Green</span>   |  |
+| Buttons            | <span class='status green'>Green</span>   |  |
+| Divider            | <span class='status green'>Green</span>   |  |
+| HTML Code          | <span class='status green'>Green</span>   |  |
+| Image              | <span class='status green'>Green</span>   |  |
+| Video              | <span class='status green'>Green</span>   |  |
+| Banner             | <span class='status green'>Green</span>   |  |
+| Slider             | <span class='status yellow'>Yellow</span> | Cannot be edited in IE 11 |
+| Map                | <span class='status green'>Green</span>   |  |
+| Block              | <span class='status green'>Green</span>   |  |
+| Dynamic Block      | <span class='status green'>Green</span>   |  |
+| Products           | <span class='status green'>Green</span>   |  |
+{:style="table-layout:auto"}
+
+## Migration
+
+| Name                              | Status                                  | Notes                                     |
+| --------------------------------- | --------------------------------------- | ----------------------|
+| 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.|
+{:style="table-layout:auto"}