docs: Restructuring of navigation and documentation resources (#892)

vuestorefront · Jun 29, 2020 · 61af541 · 61af541 · vercel · Jun 29, 2020
1 parent bd42408
commit 61af541
Show file tree

Hide file tree

Showing 165 changed files with 1,449 additions and 251 deletions.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -13,129 +13,9 @@ module.exports = {
   themeConfig: {
     repo: "DivanteLtd/shopware-pwa",
     docsDir: "docs",
-    sidebarDepth: 0,
     smoothScroll: true,
-    displayAllHeaders: true,
     logo: "/shopware_docs_horizontal.svg",
-    sidebar: [
-      {
-        title: "Home",
-        path: "/",
-        collapsable: true,
-        children: [
-          ["/landing/project/", "Project"],
-          ["/landing/getting-started/", "Getting started"],
-          ["/landing/fundamentals/", "Fundamentals"],
-          ["/landing/concepts/", "Concepts"],
-          ["/landing/operations/", "Operations"],
-          ["/landing/resources/", "Resources"],
-        ],
-      },
-    ],
-    nav: (module.exports = [
-      {
-        text: "Home",
-        link: "/",
-      },
-      /*{
-        text: "Fundamentals",
-        link: "/landing/fundamentals/"
-        items: [
-          {
-            text: "Nuxt.js",
-            link: "/fundamentals/",
-          },
-          {
-            text: "Storefront UI",
-            link: "/fundamentals/",
-          },
-          {
-            text: "PWA CLI",
-            items: [
-              {
-                text: "Themes",
-                link: "/guide/cms.html",
-              },
-              {
-                text: "Plugins",
-                link: "/guide/plugins.html",
-              },
-              {
-                text: "Payment",
-                link: "/guide/payment.html",
-              },
-            ],
-          },
-        ],
-      },*/
-      {
-        text: "Concepts",
-        items: [
-          {
-            text: "CMS",
-            link: "/guide/cms.html",
-          },
-          {
-            text: "Plugins",
-            link: "/guide/plugins.html",
-          },
-          {
-            text: "Payment",
-            link: "/guide/payment.html",
-          },
-        ],
-      },
-      {
-        text: "Resources",
-        items: [
-          {
-            text: "Roadmap",
-            link: "/guide/roadmap/",
-          },
-          {
-            text: "Package API",
-            link: "/api/",
-          },
-          {
-            text: "Troubleshooting",
-            link: "/guide/troubleshooting/",
-          },
-          {
-            text: "Cheatsheet",
-            link: "/guide/cheatsheet/",
-          },
-          {
-            text: "Contribution",
-            items: [
-              {
-                text: "Contribution Guide",
-                link: "/contribution/contributing/",
-              },
-              {
-                text: "Project Structure",
-                link: "/contribution/structure/",
-              },
-            ],
-          },
-          {
-            text: "Featurelist",
-            items: [
-              {
-                text: "Functional",
-                link: "/guide/featurelist.html#functional",
-              },
-              {
-                text: "Technical",
-                link: "/guide/featurelist.html#technical",
-              },
-              {
-                text: "Integrations",
-                link: "/guide/featurelist.html#integrations",
-              },
-            ],
-          },
-        ],
-      },
-    ]),
+    sidebar: require("./sidebar.js"),
+    nav: require("./navigation.js"),
   },
 };
diff --git a/docs/.vuepress/navigation.js b/docs/.vuepress/navigation.js
@@ -0,0 +1,6 @@
+module.exports = [
+  {
+    text: "Home",
+    link: "/",
+  },
+];
diff --git a/docs/.vuepress/sidebar.js b/docs/.vuepress/sidebar.js
@@ -0,0 +1,54 @@
+module.exports = {
+  sidebarDepth: 2,
+  "/": [
+    {
+      path: "/landing/project/",
+      title: "Project",
+      collapsable: false,
+      children: ["landing/project/contribution"],
+    },
+    {
+      path: "/landing/getting-started/",
+      title: "Getting Started",
+      collapsable: false,
+      children: ["/landing/getting-started/prepare-shopware"],
+    },
+    {
+      path: "/landing/fundamentals/",
+      title: "Fundamentals",
+      collapsable: false,
+      children: ["/landing/fundamentals/cli", "/landing/fundamentals/security"],
+    },
+    {
+      path: "/landing/concepts/",
+      title: "Concepts",
+      collapsable: false,
+      children: [
+        "/landing/concepts/cms",
+        "/landing/concepts/plugins",
+        "/landing/concepts/payment",
+      ],
+    },
+    {
+      path: "/landing/operations/",
+      title: "Operations",
+      collapsable: false,
+      children: [
+        "/landing/operations/hosting/",
+        "/landing/operations/deployment/",
+      ],
+    },
+    {
+      path: "/landing/resources/",
+      title: "Resources",
+      collapsable: false,
+      children: [
+        "/landing/resources/roadmap",
+        ["/landing/resources/api/", "Package API"],
+        "/landing/resources/features",
+        "/landing/resources/troubleshooting",
+        "/landing/resources/cheatsheet",
+      ],
+    },
+  ],
+};
diff --git a/docs/README.md b/docs/README.md
@@ -2,7 +2,7 @@
 sidebar: false
 ---
 
-![showpare-vsf-banner](./landing/assets/shopware_vsf_banner.png)
+![Shopware PWA](./landing/assets/shopware_vsf_banner.png)
 
 <center>
 
@@ -15,6 +15,17 @@ yarn global add @shopware-pwa/cli && shopware-pwa init 		# install CLI & initial
 yarn dev 													# start dev server
 ```
 
+---
+
+<center>
+
+:::tip Watch our talk on Shopware PWA
+
+[📺 Shopware PWA for Developers](https://www.youtube.com/watch?v=VVfreCzDDKM) from June, 19th (EN).
+:::
+
+</center>
+
 <div class="flex-container">
 
 <div class="md-50">	
@@ -57,6 +68,10 @@ Made with ❤️ by shopware AG & Vue Storefront
 	margin-top: 25px;
 }
 
+.preview-image {
+	width: 50%;
+}
+
 @media screen and (min-width: 720px) {
 	.flex-container {
 		display: flex;

diff --git a/docs/api/shopware-6-client.getsearchresults.md b/docs/api/shopware-6-client.getsearchresults.md
diff --git a/docs/assets/scd-talk-pwa.png b/docs/assets/scd-talk-pwa.png
diff --git a/docs/landing/concepts/README.md b/docs/landing/concepts/README.md
@@ -6,19 +6,19 @@ No matter whether you're familiar with Shopware or not - you might have come acr
 
 The content management system is certainly one of the most prominent features built into Shopware. We have prepared a guide to dig into the structure of our CMS and how to use and extend it within the PWA. 
 
-→ [CMS Guide](/guide/cms/)
+→ [CMS Guide](./cms)
 
 ## Plugins
 
 Plugins are a common concept in Shopware applications. Learn how they translate to the PWA world and how to use them to inject custom components into your layout.
 
-→ [Plugins Guide](/guide/plugins/)
+→ [Plugins Guide](./plugins)
 
 ## Payment and Checkout
 
 Checkout and payment are critical parts within every eCommerce application. Learn how payments are adopted and captured using the Shopware API and how they translate into a programmatic API that you can use in the PWA.
 
-→ [Payment Guide](/guide/payment/)
+→ [Payment Guide](./payment)
 
 ## User Management <Badge text="coming soon"/>