Merge pull request #6 from Sonichigo/v2-docs

fix: versioning of docs based on keploy version and UI update
keploy · Sep 12, 2023 · 292b869 · 292b869
2 parents 9919b27 + 3926a49
commit 292b869
Show file tree

Hide file tree

Showing 6 changed files with 131 additions and 130 deletions.
diff --git a/docs/keploy-explained/introduction.md b/docs/keploy-explained/introduction.md
@@ -19,7 +19,3 @@ import WhatAreKeployFeatures from '../concepts/what-are-keploy-features.md'
 import WhatIsAKeploySDK from '../concepts/what-is-a-keploy-sdk.md'
 
 <WhatIsAKeploySDK/>
-
-### Integrate SDK
-
-**Choose programming language to integrate [Keploy SDK](/application-development).**
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -93,7 +93,15 @@ module.exports = {
         // },
         {
           to: "https://community.keploy.io",
-          label: "Blogs",
+          label: "KB articles",
+        },
+        {
+          to: "/application-development",
+          label: "Installation",
+        },
+        {
+          to: "https://tech.keploy.io",
+          label: "Tech Blog",
         },
         // {
         //   to: "/docs/hacktoberfest/contribution-guide/",
@@ -165,9 +173,11 @@ module.exports = {
         // },
         {
           type: 'docsVersionDropdown',
-          position: 'left',
-          dropdownItemsAfter: [{to: '/version'}],
-          dropdownActiveClassDisabled: false,
+          position: 'right',
+          dropdownItemsAfter: [{
+            to: '/docs/server/linux/installation',
+          }],
+          dropdownActiveClassDisabled: true,
         },
         {
           href: "https://github.com/keploy/keploy",
@@ -233,7 +243,16 @@ module.exports = {
            * in `/docs/next` directory, only versioned docs.
            */
           // excludeNextVersionDocs: false,
-          includeCurrentVersion: false, // excludeNextVersionDocs is now deprecated
+          lastVersion: '2.0.0',
+          versions: {
+            '1.0.0': {
+              label: '1.0.0',
+              path: '1.0.0',
+              banner: 'unmaintained',
+            },
+          },
+          onlyIncludeVersions: ["1.0.0","2.0.0"],
+          includeCurrentVersion: true, // excludeNextVersionDocs is now deprecated
           // // below remark plugin disabled until we can figure out why it is not transpiling to ESNext properly - swyx
           remarkPlugins: [
             [

diff --git a/sidebars.js b/sidebars.js
@@ -1,6 +1,6 @@
 module.exports = {
   // Keploy Explanation Sidebar
-  sidebarInstallation: [
+  sidebarExplaination: [
     {
       type: "category",
       label: "Explanation",
@@ -17,48 +17,6 @@ module.exports = {
         "keploy-explained/faq",
       ],
     },
-    {
-      type: "category",
-      label: "Installation",
-      collapsible: true,
-      collapsed: false,
-      items: [
-        "server/server-installation",
-        "server/sdk-installation",
-      ],
-    },
-    {
-      type: "category",
-      label: "Concepts",
-      collapsible: true,
-      collapsed: false,
-      // link: {
-      //   type: "doc",
-      //   id: "concepts/index",
-      // },
-      items: [
-        "concepts/what-is-keploy",
-        "concepts/what-are-keploy-features",
-        "concepts/what-is-keploy-sdk",
-        "concepts/what-are-keploy-sdk-modes",
-      ],
-    },
-    {
-      type: "category",
-      label: "Operations",
-      collapsible: true,
-      collapsed: false,
-      link: {
-        type: "doc",
-        id: "operation/index",
-      },
-      items: [
-        "operation/web-ui-operations",
-        "operation/record-operations",
-        "operation/test-operations",
-        "operation/browser-extension-operations",
-      ],
-    },
     {
       type: "category",
       label: "Simplification",
@@ -79,68 +37,93 @@ module.exports = {
   ],
 
   // Keploy Go Sidebar
-  sidebarSDK: [
+  sidebarInstallation: [
     {
-      type: "category",
-      label: "Golang",
-      collapsible: true,
-      collapsed: true,
-      link: {
-        type: "doc",
-        id: "go/quickstart/index",
-      },
-      items: [
-
-        // Installation
-        {
-          type: "doc",
-          label: "Installation",
-          id: "go/installation",
-        },
+    type: "category",
+    label: "Installation",
+    collapsible: true,
+    collapsed: false,
+    items: [
+      "server/server-installation",
+      "server/sdk-installation",
+    ],
+  },
+  {
+    type: "category",
+    label: "Concepts",
+    collapsible: true,
+    collapsed: false,
+    // link: {
+    //   type: "doc",
+    //   id: "concepts/index",
+    // },
+    items: [
+      "concepts/what-is-keploy",
+      "concepts/what-are-keploy-features",
+      "concepts/what-is-keploy-sdk",
+      "concepts/what-are-keploy-sdk-modes",
+    ],
+  },
+  {
+    type: "category",
+    label: "Operations",
+    collapsible: true,
+    collapsed: false,
+    link: {
+      type: "doc",
+      id: "operation/index",
+    },
+    items: [
+      "operation/web-ui-operations",
+      "operation/record-operations",
+      "operation/test-operations",
+      "operation/browser-extension-operations",
+    ],
+  },
 
-        // Integration
-        {
-          type: "doc",
-          label: "Integration",
-          id: "go/integration",
-        },
-        // Record Test
-        {
-          type: "doc",
-          label: "Record Test",
-          id: "go/record",
-        },
-        // Replay Test
-        {
-          type: "doc",
-          label: "Replay Test ",
-          id: "go/replay",
-        },
+    //     // Integration
+    //     {
+    //       type: "doc",
+    //       label: "Integration",
+    //       id: "go/integration",
+    //     },
+    //     // Record Test
+    //     {
+    //       type: "doc",
+    //       label: "Record Test",
+    //       id: "go/record",
+    //     },
+    //     // Replay Test
+    //     {
+    //       type: "doc",
+    //       label: "Replay Test ",
+    //       id: "go/replay",
+    //     },
 
-        // Quickstarts
-        {
-          type: "category",
-          label: "Sample Quickstarts",
-          collapsible: true,
-          collapsed: true,
-          link: {
-            type: "doc",
-            id: "go/quickstart/index",
-          },
-          items: [
-            "go/quickstart/echo-sql",
-            "go/quickstart/gin-mongo",
-            "go/quickstart/gin-mongo-2",
-            "go/quickstart/gorillamux-redis"
-          ],
-        },
-        {
-          type: "link",
-          label: "Go Pkg Reference",
-          href: "https://pkg.go.dev/github.com/keploy/go-sdk",
-        },
-      ],
-    },
+    //     // Quickstarts
+    //     {
+    //       type: "category",
+    //       label: "Sample Quickstarts",
+    //       collapsible: true,
+    //       collapsed: true,
+    //       link: {
+    //         type: "doc",
+    //         id: "go/quickstart/index",
+    //       },
+    //       items: [
+    //         "go/quickstart/echo-sql",
+    //         "go/quickstart/gin-mongo",
+    //         "go/quickstart/gin-mongo-2",
+    //         "go/quickstart/gorillamux-redis"
+    //       ],
+    //     },
+    //     {
+    //       type: "link",
+    //       label: "Go Pkg Reference",
+    //       href: "https://pkg.go.dev/github.com/keploy/go-sdk",
+    //     },
+    //   ],
+    // },
 
     // Java SDK
     // {

diff --git a/src/components/Resources.js b/src/components/Resources.js
@@ -19,7 +19,7 @@ const links = [
     type: "article",
     title: "QuickStart with Go Sample App",
     length: "10 min read",
-    url: "docs/quickstart/gin-mongo",
+    url: "docs/quickstart/samples-gin",
   },
   {
     type: "article",

diff --git a/src/components/SDKs.js b/src/components/SDKs.js
@@ -19,7 +19,7 @@ export const SDKs = () => {
           <p className="text-lg">Windows</p>
         </Link>
         <Link className=" scale flex flex-col items-center justify-center space-y-3 rounded-lg bg-[color:var(--ifm-card-background-color)] p-6 text-center shadow-lg"
-          to={useBaseUrl("/docs/server/linux/")}>
+          to={useBaseUrl("/docs/server/linux/installation")}>
          <img
               className="h-16 w-16"
               src="/img/Linux.svg"

diff --git a/versioned_sidebars/version-2.0.0-sidebars.json b/versioned_sidebars/version-2.0.0-sidebars.json
@@ -1,28 +1,12 @@
 {
   "sidebarInstallation": [
-    {
-      "type": "category",
-      "label": "Explanation",
-      "collapsible": true,
-      "collapsed": false,
-      "link": {
-        "type": "doc",
-        "id": "keploy-explained/introduction"
-      },
-      "items": [
-        "keploy-explained/introduction",
-        "keploy-explained/how-keploy-works",
-        "keploy-explained/why-keploy",
-        "keploy-explained/faq"
-      ]
-    },
     {
       "type": "category",
       "label": "Installation",
       "collapsible": true,
       "link": {
         "type": "doc",
-        "id": "server/index"
+        "id": "server/linux/installation"
       },
       "collapsed": false,
       "items": [
@@ -70,5 +54,24 @@
         "concepts/general-glossary"
       ]
     }
+  ],
+
+  "sidebarExplanation": [
+    {
+      "type": "category",
+      "label": "Explanation",
+      "collapsible": true,
+      "collapsed": false,
+      "link": {
+        "type": "doc",
+        "id": "keploy-explained/introduction"
+      },
+      "items": [
+        "keploy-explained/introduction",
+        "keploy-explained/how-keploy-works",
+        "keploy-explained/why-keploy",
+        "keploy-explained/faq"
+      ]
+    }
   ]
 }