MAGETWO-91200: Update documentation for PageBuilder EAP

James Calcaben · James Calcaben · commit 42d3a181f8b9 · 2018-05-18T10:04:16.000-05:00
- add missing links to events topic and contribution guide
diff --git a/app/code/Magento/PageBuilder/docs/README.md b/app/code/Magento/PageBuilder/docs/README.md
@@ -7,7 +7,7 @@ It replaces the default WYSIWYG Editor in the Admin area with a highly configura
 
 1. **Introduction**
 2. [Installation guide]
-3. Contribution guide
+3. [Contribution guide]
 4. [Developer documentation]
     1. [Architecture overview]
     1. [BlueFoot to PageBuilder data migration]
@@ -17,10 +17,12 @@ It replaces the default WYSIWYG Editor in the Admin area with a highly configura
     1. [Additional data configuration]
     1. [Content type configuration]
     1. [How to add a new content type]
+    1. [Events]
 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
@@ -30,4 +32,5 @@ It replaces the default WYSIWYG Editor in the Admin area with a highly configura
 [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
 [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
@@ -4,7 +4,7 @@
 
 1. [Introduction]
 2. [Installation guide]
-3. Contribution guide
+3. [Contribution guide]
 4. [Developer documentation]
     1. **Architecture overview**
     1. [BlueFoot to PageBuilder data migration]
@@ -14,9 +14,11 @@
     1. [Additional data configuration]
     1. [Content type configuration]
     1. [How to add a new content type]
+    1. [Events]
 5. [Roadmap and known issues]
 
 [Introduction]: README.md
+[Contribution guide]: CONTRIBUTING.md
 [Installation Guide]: install.md
 [Developer documentation]: developer-documentation.md
 [Architecture overview]: architecture-overview.md
@@ -27,6 +29,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
 [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
@@ -3,7 +3,7 @@
 
 1. [Introduction]
 2. [Installation guide]
-3. Contribution guide
+3. [Contribution guide]
 4. [Developer documentation]
     1. [Architecture overview]
     1. **BlueFoot to PageBuilder data migration**
@@ -16,6 +16,7 @@
 5. [Roadmap and known issues]
 
 [Introduction]: README.md
+[Contribution guide]: CONTRIBUTING.md
 [Installation guide]: install.md
 [Developer documentation]: developer-documentation.md
 [Architecture overview]: architecture-overview.md
diff --git a/app/code/Magento/PageBuilder/docs/content-type-configuration.md b/app/code/Magento/PageBuilder/docs/content-type-configuration.md
@@ -7,7 +7,7 @@
 
 1. [Introduction]
 2. [Installation guide]
-3. Contribution guide
+3. [Contribution guide]
 4. [Developer documentation]
     1. [Architecture overview]
     1. [BlueFoot to PageBuilder data migration]
@@ -20,6 +20,7 @@
 5. [Roadmap and known issues]
 
 [Introduction]: README.md
+[Contribution guide]: CONTRIBUTING.md
 [Installation guide]: install.md
 [Developer documentation]: developer-documentation.md
 [Architecture overview]: architecture-overview.md
diff --git a/app/code/Magento/PageBuilder/docs/custom-configuration.md b/app/code/Magento/PageBuilder/docs/custom-configuration.md
@@ -4,7 +4,7 @@
 
 1. [Introduction]
 2. [Installation guide]
-3. Contribution guide
+3. [Contribution guide]
 4. [Developer documentation]
     1. [Architecture overview]
     1. [BlueFoot to PageBuilder data migration]
@@ -17,6 +17,7 @@
 5. [Roadmap and known issues]
 
 [Introduction]: README.md
+[Contribution guide]: CONTRIBUTING.md
 [Installation guide]: install.md
 [Developer documentation]: developer-documentation.md
 [Architecture overview]: architecture-overview.md
diff --git a/app/code/Magento/PageBuilder/docs/developer-documentation.md b/app/code/Magento/PageBuilder/docs/developer-documentation.md
@@ -4,7 +4,7 @@
 
 1. [Introduction]
 2. [Installation guide]
-3. Contribution guide
+3. [Contribution guide]
 4. **Developer documentation**
     1. [Architecture overview]
     1. [BlueFoot to PageBuilder data migration]
@@ -33,6 +33,7 @@
 **[How to add a new content type]** - Instructions for adding a new content type.
 
 [Introduction]: README.md
+[Contribution guide]: CONTRIBUTING.md
 [Installation guide]: install.md
 [Architecture overview]: architecture-overview.md
 [BlueFoot to PageBuilder data migration]: bluefoot-data-migration.md
diff --git a/app/code/Magento/PageBuilder/docs/events.md b/app/code/Magento/PageBuilder/docs/events.md
@@ -1,10 +1,44 @@
 # Events
 
-This document describes events dispatched in PageBuilder and parameters.
+## 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**
+5. [Roadmap and known issues]
+
+[Introduction]: README.md
+[Contribution guide]: CONTRIBUTING.md
+[Installation Guide]: install.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
+[Roadmap and Known Issues]: roadmap.md
+
+This document contains reference information for events dispatched in PageBuilder.
 
 **Note:**
 *We are revising naming conventions for events, naming may change.*
 
+## Events list
+
 * [block:dropped](#blockdropped)
 * [block:dropped:create](#blockdroppedcreate)
 * [block:instanceDropped](#blockinstancedropped)
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
@@ -4,7 +4,7 @@
 
 1. [Introduction]
 2. [Installation guide]
-3. Contribution guide
+3. [Contribution guide]
 4. [Developer documentation]
     1. [Architecture overview]
     1. [BlueFoot to PageBuilder data migration]
@@ -17,6 +17,7 @@
 5. [Roadmap and known issues]
 
 [Introduction]: README.md
+[Contribution guide]: CONTRIBUTING.md
 [Installation guide]: install.md
 [Developer documentation]: developer-documentation.md
 [Architecture overview]: architecture-overview.md
diff --git a/app/code/Magento/PageBuilder/docs/iconography.md b/app/code/Magento/PageBuilder/docs/iconography.md
@@ -4,7 +4,7 @@
 
 1. [Introduction]
 2. [Installation guide]
-3. Contribution guide
+3. [Contribution guide]
 4. [Developer documentation]
     1. [Architecture overview]
     1. [BlueFoot to PageBuilder data migration]
@@ -17,6 +17,7 @@
 5. [Roadmap and known issues]
 
 [Introduction]: README.md
+[Contribution guide]: CONTRIBUTING.md
 [Installation guide]: install.md
 [Developer documentation]: developer-documentation.md
 [Architecture overview]: architecture-overview.md
diff --git a/app/code/Magento/PageBuilder/docs/install.md b/app/code/Magento/PageBuilder/docs/install.md
@@ -8,11 +8,12 @@
     1. [Composer installation](#composer-installation)
     1. [GitHub installation](#github-installation)
     1. [Activation](#activation)
-3. Contribution guide
+3. [Contribution guide]
 4. [Developer documentation]
 5. [Roadmap and known issues]
 
 [Introduction]: README.md
+[Contribution guide]: CONTRIBUTING.md
 [Developer documentation]: developer-documentation.md
 [Roadmap and known issues]: roadmap.md
 
diff --git a/app/code/Magento/PageBuilder/docs/module-integration.md b/app/code/Magento/PageBuilder/docs/module-integration.md
@@ -4,7 +4,7 @@
 
 1. [Introduction]
 2. [Installation guide]
-3. Contribution guide
+3. [Contribution guide]
 4. [Developer documentation]
     1. [Architecture overview]
     1. [BlueFoot to PageBuilder data migration]
@@ -17,6 +17,7 @@
 5. [Roadmap and known issues]
 
 [Introduction]: README.md
+[Contribution guide]: CONTRIBUTING.md
 [Installation guide]: install.md
 [Developer documentation]: developer-documentation.md
 [Architecture overview]: architecture-overview.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
@@ -4,7 +4,7 @@
 
 1. [Introduction]
 2. [Installation guide]
-3. Contribution guide
+3. [Contribution guide]
 4. [Developer documentation]
     1. [Architecture overview]
     1. [BlueFoot to PageBuilder data migration]
@@ -17,6 +17,7 @@
 5. [Roadmap and known issues]
 
 [Introduction]: README.md
+[Contribution guide]: CONTRIBUTING.md
 [Installation guide]: install.md
 [Developer documentation]: developer-documentation.md
 [Architecture overview]: architecture-overview.md
diff --git a/app/code/Magento/PageBuilder/docs/roadmap.md b/app/code/Magento/PageBuilder/docs/roadmap.md
@@ -4,7 +4,7 @@
 
 1. [Introduction]
 2. [Installation guide]
-3. Contribution guide
+3. [Contribution guide]
 4. [Developer documentation]
 5. **Roadmap and Known Issues**
    1. [Overview](#overview)
@@ -14,6 +14,7 @@
 
 [Introduction]: README.md
 [Installation guide]: install.md
+[Contribution guide]: CONTRIBUTING.md
 [Developer documentation]: developer-documentation.md
 [BlueFoot to PageBuilder data migration]: bluefoot-data-migration.md
 [Third-party content type migration]: new-content-type-example.md
