v2 Migration guide

.wordlist.txt

@@ -1069,4 +1069,7 @@ golangcode
 Sprintf
 apiKey
 fileUrl
-
+stepName
+firstName
+Golang
+UX

docs/docs/.vuepress/config.js

@@ -44,6 +44,7 @@ module.exports = {
         ],
       },
     ],
+    smoothScroll: false,
     // if your docs are not at the root of the repo:
     docsDir: "docs/docs",
     editLinks: true,
@@ -65,6 +66,7 @@ module.exports = {
           "/environment-variables/",
           "/workflows/settings/",
           "/workflows/networking/",
+          "/migrate-from-v1/",
         ]
       },
       "/sources/",

docs/docs/.vuepress/enhanceApp.js

@@ -1,5 +1,37 @@
 import VueGtm from "vue-gtm";
 
+// fork from vue-router@3.0.2
+// src/util/scroll.js
+function getElementPosition(el) {
+  const docEl = document.documentElement
+  const docRect = docEl.getBoundingClientRect()
+  const elRect = el.getBoundingClientRect()
+  return {
+    x: elRect.left - docRect.left,
+    y: elRect.top - docRect.top,
+  }
+}
+
+/**
+ * Fix broken Vuepress scrolling to internal #links
+ * 
+ * @param {String} to 
+ * @returns void
+ */
+function scrollToAnchor(to) {
+  const targetAnchor = to.hash.slice(1)
+  const targetElement = document.getElementById(targetAnchor) || document.querySelector(`[name='${targetAnchor}']`)
+
+  if (targetElement) {
+    return window.scrollTo({
+      top: getElementPosition(targetElement).y,
+      behavior: 'smooth',
+    })
+  } else {
+    return false
+  }
+}
+
 export default ({
   Vue, // the version of Vue being used in the VuePress app
   options, // the options for the root Vue instance
@@ -15,6 +47,35 @@ export default ({
     });
   }
 
+  // Adapted from https://github.com/vuepress/vuepress-community/blob/7feb5c514090b6901cd7d9998f4dd858e0055b7a/packages/vuepress-plugin-smooth-scroll/src/enhanceApp.ts#L21
+  // With a bug fix for handling long pages
+  router.options.scrollBehavior = (to, from, savedPosition) => {
+    if (savedPosition) {
+      return window.scrollTo({
+        top: savedPosition.y,
+        behavior: 'smooth',
+      })
+    } else if (to.hash) {
+      if (Vue.$vuepress.$get('disableScrollBehavior')) {
+        return false
+      }
+      const scrollResult = scrollToAnchor(to)
+
+      if (scrollResult) {
+        return scrollResult
+      } else {
+        window.onload = () => {
+          scrollToAnchor(to)
+        }
+      }
+    } else {
+      return window.scrollTo({
+        top: 0,
+        behavior: 'smooth',
+      })
+    }
+  }
+
   router.addRoutes([
     { path: "/cron", redirect: "/workflows/steps/triggers" },
     { path: "/notebook", redirect: "/workflows/steps" },