Merge pull request #1897 from magento-obsessive-owls/PB-36

[PB][Docs] PB-36: Creating custom Page Builder components

pwa-devdocs/.gitignore

@@ -1,6 +1,7 @@
 _site/
 .sass-cache/
 .jekyll-metadata
+.jekyll-cache
 
 node_modules
 src/builds

pwa-devdocs/scripts/create-reference-docs/config/venia-concept/index.js

@@ -74,5 +74,13 @@ module.exports = [
     {
         target: 'venia-ui/lib/components/RichContent/PageBuilder/ContentTypes/Map/map.js',
         type: 'function'
+    },
+    {
+        target: 'venia-ui/lib/components/RichContent/PageBuilder/ContentTypes/Banner/banner.js',
+        type: 'function'
+    },
+    {
+        target: 'venia-ui/lib/components/RichContent/PageBuilder/utils.js',
+        type: 'function'
     }
 ];

pwa-devdocs/src/_data/pagebuilder.yml

@@ -1,55 +1,77 @@
 title: Page Builder
 entries:
-    - label: Integration Overview
-      url: /pagebuilder/overview/
-
-    - label: Create custom components 
-      url: /pagebuilder/creating-pb-components/
+    - label: Integration
+      url: /pagebuilder/
 
-    - label: Page Builder components
+    - label: Known limitations
+      url: /pagebuilder/known-limitations/
+
+    - label: Creating custom components
       entries:
-          - label: Row
-            url: /pagebuilder/components/row/
+          - label: Overview
+            url: /pagebuilder/custom-components/overview/
 
-          - label: Column
-            url: /pagebuilder/components/column/
-
-          - label: Tabs
-            url: /pagebuilder/components/tabs/
+          - label: Set up component
+            url: /pagebuilder/custom-components/setup-component/
+
+          - label: Add aggregator
+            url: /pagebuilder/custom-components/add-aggregator/
+
+          - label: Add stylesheet
+            url: /pagebuilder/custom-components/add-stylesheet/
+
+          - label: Add component
+            url: /pagebuilder/custom-components/add-component/
+
+          - label: Debugging tips
+            url: /pagebuilder/custom-components/debugging/
+
+    - label: Utility functions
+      url: /pagebuilder/utility-functions/
+
+    - label: Components
+      entries:
+          - label: Banner
+            url: /pagebuilder/components/banner/
+
+          - label: Block
+            url: /pagebuilder/components/block/
 
-          - label: Text
-            url: /pagebuilder/components/text/
-
-          - label: Heading
-            url: /pagebuilder/components/heading/
-
           - label: Buttons
             url: /pagebuilder/components/buttons/
-
+
+          - label: Column
+            url: /pagebuilder/components/column/
+
           - label: Divider
             url: /pagebuilder/components/divider/
-
+
+          - label: Heading
+            url: /pagebuilder/components/heading/
+
           - label: HTML Code
             url: /pagebuilder/components/html/
-            
+
           - label: Image
             url: /pagebuilder/components/image/
-
-          - label: Video
-            url: /pagebuilder/components/video/
-
-          - label: Banner
-            url: /pagebuilder/components/banner/
-
-          - label: Slider
-            url: /pagebuilder/components/slider/
-
+
           - label: Map
             url: /pagebuilder/components/map/
-
-          - label: Block
-            url: /pagebuilder/components/block/
-
+
           - label: Products
             url: /pagebuilder/components/products/
-
+
+          - label: Row
+            url: /pagebuilder/components/row/
+
+          - label: Slider
+            url: /pagebuilder/components/slider/
+
+          - label: Tabs
+            url: /pagebuilder/components/tabs/
+
+          - label: Text
+            url: /pagebuilder/components/text/
+
+          - label: Video
+            url: /pagebuilder/components/video/

pwa-devdocs/src/_data/top-nav.yml

@@ -7,9 +7,6 @@
 - label: Peregrine Components
   url: /peregrine/
 
-- label: PageBuilder
-  url: /pagebuilder/
-
 - label: Venia Storefront
   url: /venia-pwa-concept/
 

pwa-devdocs/src/_drafts/pagebuilder/components/banner/index.md

@@ -0,0 +1,10 @@
+---
+title: Banner
+---
+
+<!--
+The reference doc content is generated automatically from the source code.
+To update this section, update the doc blocks in the source code
+-->
+
+{% include auto-generated/venia-ui/lib/components/RichContent/PageBuilder/ContentTypes/Banner/banner.md %}

pwa-devdocs/src/pagebuilder/components/block/index.md → pwa-devdocs/src/_drafts/pagebuilder/components/block/index.md

@@ -6,4 +6,5 @@ title: Block
 The reference doc content is generated automatically from the source code.
 To update this section, update the doc blocks in the source code
 -->
+
 {% include auto-generated/venia-ui/lib/components/RichContent/PageBuilder/ContentTypes/Block/block.md %}

pwa-devdocs/src/_drafts/pagebuilder/components/buttons/index.md

@@ -0,0 +1,11 @@
+---
+title: Buttons
+---
+
+<!--
+The reference doc content is generated automatically from the source code.
+To update this section, update the doc blocks in the source code
+-->
+
+{% include auto-generated/venia-ui/lib/components/RichContent/PageBuilder/ContentTypes/Buttons/buttons.md %}
+{% include auto-generated/venia-ui/lib/components/RichContent/PageBuilder/ContentTypes/ButtonItem/buttonItem.md %}

pwa-devdocs/src/pagebuilder/components/column/index.md → pwa-devdocs/src/_drafts/pagebuilder/components/column/index.md

@@ -6,5 +6,6 @@ title: Column
 The reference doc content is generated automatically from the source code.
 To update this section, update the doc blocks in the source code
 -->
+
 {% include auto-generated/venia-ui/lib/components/RichContent/PageBuilder/ContentTypes/Column/column.md %}
 {% include auto-generated/venia-ui/lib/components/RichContent/PageBuilder/ContentTypes/ColumnGroup/columnGroup.md %}

pwa-devdocs/src/_drafts/pagebuilder/components/divider/index.md

@@ -0,0 +1,10 @@
+---
+title: Divider
+---
+
+<!--
+The reference doc content is generated automatically from the source code.
+To update this section, update the doc blocks in the source code
+-->
+
+{% include auto-generated/venia-ui/lib/components/RichContent/PageBuilder/ContentTypes/Divider/divider.md %}

pwa-devdocs/src/_drafts/pagebuilder/components/heading/index.md

@@ -0,0 +1,10 @@
+---
+title: Heading
+---
+
+<!--
+The reference doc content is generated automatically from the source code.
+To update this section, update the doc blocks in the source code
+-->
+
+{% include auto-generated/venia-ui/lib/components/RichContent/PageBuilder/ContentTypes/Heading/heading.md %}

pwa-devdocs/src/pagebuilder/components/html/index.md → pwa-devdocs/src/_drafts/pagebuilder/components/html/index.md

@@ -1,8 +1,10 @@
 ---
 title: HTML Code
 ---
+
 <!--
 The reference doc content is generated automatically from the source code.
 To update this section, update the doc blocks in the source code
 -->
+
 {% include auto-generated/venia-ui/lib/components/RichContent/PageBuilder/ContentTypes/Html/html.md %}

pwa-devdocs/src/pagebuilder/components/image/index.md → pwa-devdocs/src/_drafts/pagebuilder/components/image/index.md

@@ -6,4 +6,5 @@ title: Image
 The reference doc content is generated automatically from the source code.
 To update this section, update the doc blocks in the source code
 -->
+
 {% include auto-generated/venia-ui/lib/components/RichContent/PageBuilder/ContentTypes/Image/image.md %}

pwa-devdocs/src/_drafts/pagebuilder/components/map/index.md

@@ -0,0 +1,10 @@
+---
+title: Map
+---
+
+<!--
+The reference doc content is generated automatically from the source code.
+To update this section, update the doc blocks in the source code
+-->
+
+{% include auto-generated/venia-ui/lib/components/RichContent/PageBuilder/ContentTypes/Map/map.md %}

pwa-devdocs/src/_drafts/pagebuilder/components/products/index.md

@@ -0,0 +1,10 @@
+---
+title: Products
+---
+
+<!--
+The reference doc content is generated automatically from the source code.
+To update this section, update the doc blocks in the source code
+-->
+
+{% include auto-generated/venia-ui/lib/components/RichContent/PageBuilder/ContentTypes/Products/products.md %}

pwa-devdocs/src/_drafts/pagebuilder/components/slider/index.md

@@ -0,0 +1,10 @@
+---
+title: Slider
+---
+
+<!--
+The reference doc content is generated automatically from the source code.
+To update this section, update the doc blocks in the source code
+-->
+
+{% include auto-generated/venia-ui/lib/components/RichContent/PageBuilder/ContentTypes/Slider/slider.md %}

pwa-devdocs/src/_drafts/pagebuilder/components/tabs/index.md

@@ -0,0 +1,11 @@
+---
+title: Tabs
+---
+
+<!--
+The reference doc content is generated automatically from the source code.
+To update this section, update the doc blocks in the source code
+-->
+
+{% include auto-generated/venia-ui/lib/components/RichContent/PageBuilder/ContentTypes/Tabs/tabs.md %}
+{% include auto-generated/venia-ui/lib/components/RichContent/PageBuilder/ContentTypes/TabItem/tabItem.md %}

pwa-devdocs/src/_drafts/pagebuilder/components/text/index.md

@@ -0,0 +1,10 @@
+---
+title: Text
+---
+
+<!--
+The reference doc content is generated automatically from the source code.
+To update this section, update the doc blocks in the source code
+-->
+
+{% include auto-generated/venia-ui/lib/components/RichContent/PageBuilder/ContentTypes/Text/text.md %}

pwa-devdocs/src/pagebuilder/components/video/index.md → pwa-devdocs/src/_drafts/pagebuilder/components/video/index.md

@@ -6,4 +6,5 @@ title: Video
 The reference doc content is generated automatically from the source code.
 To update this section, update the doc blocks in the source code
 -->
+
 {% include auto-generated/venia-ui/lib/components/RichContent/PageBuilder/ContentTypes/Video/video.md %}