MAGETWO-91200: Update documentation for PageBuilder EAP

James Calcaben · James Calcaben · commit 14fea2179291 · 2018-05-18T14:04:08.000-05:00
- Add and fix navigation
diff --git a/README.md b/README.md
@@ -34,6 +34,8 @@ This project repository contains PageBuilder developer documentation on the foll
 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
@@ -44,6 +46,8 @@ This project repository contains PageBuilder developer documentation on the foll
 [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
 
diff --git a/app/code/Magento/PageBuilder/docs/CONTRIBUTING.md b/app/code/Magento/PageBuilder/docs/CONTRIBUTING.md
@@ -1,5 +1,36 @@
 # 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”).
 
diff --git a/app/code/Magento/PageBuilder/docs/README.md b/app/code/Magento/PageBuilder/docs/README.md
@@ -18,6 +18,8 @@ It replaces the default WYSIWYG Editor in the Admin area with a highly configura
     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
@@ -33,4 +35,6 @@ It replaces the default WYSIWYG Editor in the Admin area with a highly configura
 [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
diff --git a/app/code/Magento/PageBuilder/docs/architecture-overview.md b/app/code/Magento/PageBuilder/docs/architecture-overview.md
@@ -15,6 +15,8 @@
     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
@@ -30,6 +32,8 @@
 [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
 
 ## What is PageBuilder?
diff --git a/app/code/Magento/PageBuilder/docs/bluefoot-data-migration.md b/app/code/Magento/PageBuilder/docs/bluefoot-data-migration.md
@@ -13,6 +13,9 @@
     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
@@ -27,6 +30,9 @@
 [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
 
 ## Overview
diff --git a/app/code/Magento/PageBuilder/docs/content-type-configuration.md b/app/code/Magento/PageBuilder/docs/content-type-configuration.md
@@ -17,6 +17,9 @@
     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
@@ -31,6 +34,9 @@
 [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
 
 ## Configuration
diff --git a/app/code/Magento/PageBuilder/docs/custom-configuration.md b/app/code/Magento/PageBuilder/docs/custom-configuration.md
@@ -14,6 +14,9 @@
     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
@@ -28,6 +31,9 @@
 [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
 
 
diff --git a/app/code/Magento/PageBuilder/docs/developer-documentation.md b/app/code/Magento/PageBuilder/docs/developer-documentation.md
@@ -14,6 +14,9 @@
     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]
 
 **[Architecture overview]** - An overview of the PageBuilder module architecture.
@@ -32,6 +35,12 @@
 
 **[How to add a new content type]** - Instructions for adding a new content type.
 
+**[Events]** - Reference documentation for PageBuilder events.
+
+**[Master format]** - Describes the master format for PageBuilder content types.
+
+**[Visual select]** - Documentation on customizing the visual select field.
+
 [Introduction]: README.md
 [Contribution guide]: CONTRIBUTING.md
 [Installation guide]: install.md
@@ -43,4 +52,7 @@
 [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
diff --git a/app/code/Magento/PageBuilder/docs/events.md b/app/code/Magento/PageBuilder/docs/events.md
@@ -15,6 +15,8 @@
     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
@@ -30,6 +32,8 @@
 [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
 
 This document contains reference information for events dispatched in PageBuilder.
diff --git a/app/code/Magento/PageBuilder/docs/how-to-add-new-content-type.md b/app/code/Magento/PageBuilder/docs/how-to-add-new-content-type.md
@@ -14,6 +14,9 @@
     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
@@ -28,6 +31,9 @@
 [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
 
 
diff --git a/app/code/Magento/PageBuilder/docs/iconography.md b/app/code/Magento/PageBuilder/docs/iconography.md
@@ -14,6 +14,9 @@
     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
@@ -28,6 +31,9 @@
 [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
 
 ## Overview
diff --git a/app/code/Magento/PageBuilder/docs/master-format.md b/app/code/Magento/PageBuilder/docs/master-format.md
@@ -1,8 +1,42 @@
 # Master format
 
-For storage (later master format) Page Builder uses XHTML with inline styles and data attributes.
-
-This document describes master format for default Page Builder content types.
+## 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
+
+PageBuilder uses XHTML with inline styles and data attributes as the master format for storage.
 
 **Note:**
 *We are still revising master format and it may change.*
diff --git a/app/code/Magento/PageBuilder/docs/module-integration.md b/app/code/Magento/PageBuilder/docs/module-integration.md
@@ -14,6 +14,9 @@
     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
@@ -28,6 +31,9 @@
 [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
 
 
diff --git a/app/code/Magento/PageBuilder/docs/new-content-type-example.md b/app/code/Magento/PageBuilder/docs/new-content-type-example.md
@@ -14,6 +14,9 @@
     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
@@ -28,6 +31,9 @@
 [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
 
 
diff --git a/app/code/Magento/PageBuilder/docs/visual-select.md b/app/code/Magento/PageBuilder/docs/visual-select.md
@@ -1,5 +1,41 @@
 # Visual Select
 
+## 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
+
 ## What's in this topic
 This topic describes how to extend some Page Builder fields to accommodate a custom look and feel for the text alignment option.
 
