Merge remote-tracking branch 'origin/master' into server-installation

Author: shivendra-webkul

docs/.vuepress/config.js

@@ -22,6 +22,7 @@ module.exports = {
         logo: '/logo.svg',
         nav: [
             { text: 'Home', link: '/' },
+            { text: 'User Guide', link: 'https://docs.krayincrm.com/' },
             { text: 'Community Forum', link: 'https://forums.krayincrm.com/' },
         ],
 

docs/.vuepress/theme/components/PageNav.vue

@@ -59,8 +59,6 @@
 
 <script>
 import { resolvePage } from '../util'
-import isString from 'lodash/isString'
-import isNil from 'lodash/isNil'
 
 export default {
   name: 'PageNav',
@@ -103,43 +101,44 @@ function resolvePageLink (
   linkType,
   { $themeConfig, $page, $route, $site, sidebarItems }
 ) {
-  const { resolveLink, getThemeLinkConfig, getPageLinkConfig } = linkType
+  const { resolveLink, getThemeLinkConfig, getPageLinkConfig } = linkType;
 
-  // Get link config from theme
-  const themeLinkConfig = getThemeLinkConfig($themeConfig)
+  const link = getPageLinkConfig($page) ?? getThemeLinkConfig($themeConfig);
 
-  // Get link config from current page
-  const pageLinkConfig = getPageLinkConfig($page)
+  if (link === false) return null;
+  if (typeof link === "string") return resolvePage($site.pages, link, $route.path);
 
-  // Page link config will overwrite global theme link config if defined
-  const link = isNil(pageLinkConfig) ? themeLinkConfig : pageLinkConfig
-
-  if (link === false) {
-    return
-  } else if (isString(link)) {
-    return resolvePage($site.pages, link, $route.path)
-  } else {
-    return resolveLink($page, sidebarItems)
-  }
+  return resolveLink($page, sidebarItems);
 }
 
-function find (page, items, offset) {
-  const res = []
-  flatten(items, res)
+function find(page, items, offset) {
+  const res = [];
+  flatten(items, res);
+
   for (let i = 0; i < res.length; i++) {
-    const cur = res[i]
-    if (cur.type === 'page' && cur.path === decodeURIComponent(page.path)) {
-      return res[i + offset]
+    const cur = res[i];
+
+    const isPageMatch =
+      cur.type === 'page' && cur.path === decodeURIComponent(page.path);
+
+    const isGroupMatch =
+      cur.type === 'group' && cur.title === decodeURIComponent(page.title);
+
+    if (isPageMatch || isGroupMatch) {
+      return res[i + offset] || null;
     }
   }
+
+  return null;
 }
 
 function flatten (items, res) {
-  for (let i = 0, l = items.length; i < l; i++) {
-    if (items[i].type === 'group') {
-      flatten(items[i].children || [], res)
-    } else {
-      res.push(items[i])
+  for (let i = 0; i < items.length; i++) {
+    const currentItem = items[i];
+    res.push(currentItem);
+
+    if (currentItem.type === 'group') {
+      flatten(currentItem.children || [], res);
     }
   }
 }

docs/.vuepress/theme/components/SidebarGroup.vue

@@ -17,7 +17,7 @@
         'active': isActive($route, item.path)
       }"
       :to="item.path"
-      @click.native="$emit('toggle')"
+      @click.native="$emit('toggle', index)"
     >
       <span>{{ item.title }}</span>
       <span
@@ -31,7 +31,7 @@
       v-else
       class="sidebar-heading"
       :class="{ open }"
-      @click="$emit('toggle')"
+      @click="$emit('toggle', index)"
     >
       <span>{{ item.title }}</span>
       <span
@@ -69,15 +69,35 @@ export default {
     'item',
     'open',
     'collapsable',
-    'depth'
+    'depth',
+    'index'
   ],
 
-  // ref: https://vuejs.org/v2/guide/components-edge-cases.html#Circular-References-Between-Components
-  beforeCreate () {
+  beforeCreate() {
     this.$options.components.SidebarLinks = require('@theme/components/SidebarLinks.vue').default
   },
 
-  methods: { isActive }
+  mounted() {
+    this.openSideBar();
+  },
+
+  methods: {
+    isActive(route, path) {
+      if (!path) return false;
+
+      if (path === '/') {
+        return route.path === path;
+      }
+
+      return route.path.startsWith(path);
+    },
+
+    openSideBar() {
+      if (this.item.path === this.$route.matched[0].path) {
+        this.$emit('toggle', this.index);
+      }
+    }
+  }
 }
 </script>
 

docs/.vuepress/theme/components/SidebarLinks.vue

@@ -10,6 +10,7 @@
       <SidebarGroup
         v-if="item.type === 'group'"
         :item="item"
+        :index="i"
         :open="i === openGroupIndex"
         :collapsable="item.collapsable || item.collapsible"
         :depth="depth"
@@ -36,14 +37,14 @@ export default {
 
   props: [
     'items',
-    'depth',  // depth of current sidebar links
-    'sidebarDepth', // depth of headers to be extracted
+    'depth',
+    'sidebarDepth',
     'initialOpenGroupIndex'
   ],
 
   data () {
     return {
-      openGroupIndex: this.initialOpenGroupIndex || 0
+      openGroupIndex: this.initialOpenGroupIndex || 0,
     }
   },
 
@@ -68,36 +69,36 @@ export default {
       }
     },
 
-    toggleGroup (index) {
+    toggleGroup(index) {
       this.openGroupIndex = index === this.openGroupIndex ? -1 : index
     },
 
     isActive (page) {
-      return isActive(this.$route, page.regularPath)
+      return isActive(this.$route, page.regularPath);
     }
   }
 }
 
 function resolveOpenGroupIndex (route, items) {
   for (let i = 0; i < items.length; i++) {
-    const item = items[i]
+    const item = items[i];
     if (descendantIsActive(route, item)) {
-      return i
+      return i;
     }
   }
-  return -1
+  return -1;
 }
 
 function descendantIsActive (route, item) {
   if (item.type === 'group') {
     return item.children.some(child => {
       if (child.type === 'group') {
-        return descendantIsActive(route, child)
+        return descendantIsActive(route, child);
       } else {
-        return child.type === 'page' && isActive(route, child.path)
+        return child.type === 'page' && isActive(route, child.path);
       }
-    })
+    });
   }
-  return false
+  return false;
 }
 </script>

docs/.vuepress/theme/layouts/Layout.vue

@@ -71,6 +71,20 @@ export default {
   },
 
   computed: {
+    headMeta() {
+      const { frontmatter } = this.$page;
+
+      const { title: siteTitle = 'Krayin CRM Developer Portal' } = this.$site;
+
+      return {
+        title: frontmatter.title || this.$title || siteTitle,
+
+        description: frontmatter.description || 'Krayin CRM is an open-source, customizable CRM solution designed to streamline customer management and improve business workflows.',
+
+        keywords: frontmatter.keywords || 'krayin crm extension, extension development',
+      };
+    },
+
     shouldShowNavbar () {
       const { themeConfig } = this.$site
       const { frontmatter } = this.$page
@@ -121,17 +135,23 @@ export default {
     }
   },
 
-  mounted () {
-    this.updateTopNavStyles();
+  mounted() {
+    this.updatePageAttributes();
 
     this.$router.afterEach(() => {
       this.isSidebarOpen = false;
 
-      this.updateTopNavStyles();
+      this.updatePageAttributes();
     });
   },
 
   methods: {
+    updatePageAttributes() {
+      this.updateMetaTags();
+
+      this.updateTopNavStyles();
+    },
+
     updateTopNavStyles() {
       let currentPath = this.$route.path.split('/');
       
@@ -144,6 +164,28 @@ export default {
       }
     },
 
+    updateMetaTags() {
+      const { title, description, keywords } = this.headMeta;
+
+      document.title = title;
+
+      const updateMetaTag = (name, content) => {
+        let metaTag = document.querySelector(`meta[name="${name}"]`);
+
+        if (! metaTag) {
+          metaTag = document.createElement('meta');
+          metaTag.name = name;
+          document.head.appendChild(metaTag);
+        }
+
+        metaTag.content = content;
+      };
+
+      updateMetaTag('description', description);
+
+      updateMetaTag('keywords', keywords);
+    },
+
     applyTopNavCustomStyles() {
       setTimeout(() => {
         document.querySelectorAll('.navbar').forEach(element => element.classList.add('custom-navbar-top-height'));

docs/.vuepress/version-configs/2.0.js

@@ -30,6 +30,7 @@ module.exports = [
         children: setVersionPrefix([
             ['introduction/requirements', 'Requirements'],
             ['introduction/installation', 'Installation'],
+            ['introduction/docker', 'Docker'],
         ]),
     },
     {

docs/.vuepress/version-configs/master.js

@@ -30,6 +30,7 @@ module.exports = [
         children: setVersionPrefix([
             ['introduction/requirements', 'Requirements'],
             ['introduction/installation', 'Installation'],
+            ['introduction/docker', 'Docker'],
         ]),
     },
     {

docs/2.0/advanced/email-inbound-parse.md

@@ -63,7 +63,7 @@ Krayin CRM is capable of handling attachments that are sent via email. These att
 3. Krayin CRM processes the incoming email, stores the details, and displays the email in the **Mail > Inbox** section.
 
 
-### **IMAP Inbound Parse**
+<!-- ### **IMAP Inbound Parse**
 
 Krayin CRM allows you to receive and manage your emails using the IMAP protocol. To integrate IMAP in Krayin CRM, we will use the **Webklex-IMAP** package as the email receiver driver.
 
@@ -123,4 +123,4 @@ This tells Krayin CRM to use the Webklex IMAP package to handle incoming emails.
 
 Once the IMAP settings are configured in the `.env` file, Krayin CRM will be able to use IMAP to fetch emails from the specified email account.
 
-Make sure to check your email provider’s documentation for the correct IMAP settings.
+Make sure to check your email provider’s documentation for the correct IMAP settings. -->