docs 2.1

.spellcheck.yml

@@ -14,6 +14,14 @@ matrix:
       ignores:
       - code
       - pre
+  - pyspelling.filters.context:
+      delimiters:
+      # Ignore multiline content in frontmatter (frontmatter has 3 dashes)
+      # ---
+      # content
+      # ---
+      - open: '(?s)^(?P<open> *\-{3})$'
+        close: '^(?P=open)$'
   sources:
   - '**/*.md'
   default_encoding: utf-8

docs/.gitignore

@@ -1,4 +1,3 @@
 yarn-error.log
 node_modules
-docs/.vuepress/dist/
 .DS_Store

docs/docs/.vuepress/components/GuideLink.vue

@@ -0,0 +1,112 @@
+<style lang="stylus">
+.guide-container.nodejs {
+  border-top: solid #4DA925 1em;
+}
+
+.guide-container.python {
+  border-top: solid #F5BC00 1em;
+}
+
+.guide-container.bash {
+  border-top: solid #000 1em;
+}
+
+.guide-container.go {
+  border-top: solid #00ACD7 1em;
+  text-decoration: none;
+}
+
+.guide-container:hover {
+  text-decoration: none !important;
+}
+
+.guide-container.go h3 {
+  color: #00ACD7;
+}
+
+.guide-container.bash h3 {
+  color: #000;
+}
+
+.guide-container.python h3 {
+  color: #F5BC00;
+}
+
+.guide-container.nodejs {
+  color: #4DA925;
+}
+</style>
+
+<template>
+  <div>
+    <a
+      v-for="guide in guides"
+      :key="guide.key"
+      class="
+        guide-container
+        px-5
+        py-3
+        my-4
+        rounded-md
+        shadow-md
+        hover:shadow-lg
+        relative
+        block
+      "
+      :class="guide.language"
+      :href="guide.path"
+    >
+      <div class="flex items-center">
+        <img :src="guide.frontmatter.thumbnail" width="75" />
+        <div class="flex flex-col mx-3">
+          <h3 class="text-xl">
+            {{ guide.title }}
+          </h3>
+          <span class="font-light text-gray-700">
+            {{ guide.frontmatter.short_description }}
+          </span>
+        </div>
+      </div>
+      <span class="absolute bottom-0 right-0">
+        <img :src="guide.language_thumbnail" width="50" />
+      </span>
+    </a>
+  </div>
+</template>
+
+<script>
+import orderBy from "lodash/orderBy";
+
+export default {
+  name: "GuideLink",
+  data() {
+    return { guides: [] };
+  },
+  mounted() {
+    const notApplicablePages = [
+      "/code/",
+      "/code/nodejs/",
+      "/code/python/",
+      "/code/go/",
+      "/code/bash/",
+    ];
+
+    const guides = this.$site.pages
+      .filter((page) => {
+        return (
+          page.regularPath.startsWith("/code/") &&
+          !notApplicablePages.includes(page.regularPath)
+        );
+      })
+      .map((guide) => {
+        guide.language = guide.path.match(/\/code\/(\w+)\/.*/)?.[1];
+        guide.language_thumbnail =
+          this.$site.themeConfig.icons[guide.language].only_icon;
+        return guide;
+      });
+
+    this.guides = orderBy(guides, ["language"], "desc");
+  },
+};
+</script>
+

docs/docs/.vuepress/components/LanguageLink.vue

@@ -0,0 +1,17 @@
+<template>
+  <div class="flex justify-center items-center">
+    <a :href="link">
+      <img :alt="name" :src="icon" width="100" />
+    </a>
+  </div>
+</template>
+<script>
+export default {
+  props: {
+    icon: String,
+    name: String,
+    link: String,
+  },
+  name: "LanguageLink",
+};
+</script>

docs/docs/.vuepress/config.js

@@ -1,5 +1,6 @@
 const path = require("path");
 const webpack = require("webpack");
+const themeConfig = require("./configs/themeConfig");
 
 module.exports = {
   title: "",
@@ -18,195 +19,8 @@ module.exports = {
       },
     ],
   ],
-  themeConfig: {
-    algolia: {
-      appId: 'XY28M447C5',
-      apiKey: "9d9169458128b3d60c22bb04da4431c7",
-      indexName: "pipedream",
-      algoliaOptions: {
-        facetFilters: ['version:latest']
-      }
-    },
-    searchPlaceholder: "Search...",
-    logo: "/pipedream.svg",
-    repo: "PipedreamHQ/pipedream",
-    nav: [
-      {
-        text: "v2",
-        className: "docs-version",
-        ariaLabel: "Docs Version Menu",
-        items: [
-          {
-            text: "v2",
-            link: "https://pipedream.com/docs",
-            internal: true,
-            badge: "New",
-            badgeVariation: "primary",
-          },
-          {
-            text: "v1",
-            internal: true,
-            link: "https://pipedream.com/docs/v1",
-          },
-        ],
-      },
-    ],
-    smoothScroll: false,
-    // if your docs are not at the root of the repo:
-    docsDir: "docs/docs",
-    editLinks: true,
-    // custom text for edit link. Defaults to "Edit this page"
-    editLinkText: "Help us improve this page! Submit an edit on Github",
-    sidebar: [
-      "/",
-      "/quickstart/",
-      {
-        title: "Workflows",
-        children: 
-        [
-          "/workflows/",
-          "/workflows/steps/",
-          "/workflows/steps/triggers/",
-          "/workflows/events/",
-          "/components/actions/",
-          "/workflows/concurrency-and-throttling/",
-          "/environment-variables/",
-          "/workflows/settings/",
-          "/workflows/networking/",
-          "/migrate-from-v1/",
-        ]
-      },
-      "/sources/",
-      "/connected-accounts/",
-      "/user-settings/",
-      {
-        title: "Reference: Code, APIs + CLI",
-        children: [
-          {
-            title: "Writing Code in Workflows",
-            type: "group",
-            initialOpenGroupIndex: 1,
-            children: [
-              "/code/",
-              {
-                title: "Node.js",
-                type: "group",
-                children: [
-                  "/code/nodejs/",
-                  "/code/nodejs/auth/",
-                  "/code/nodejs/http-requests/",
-                  "/code/nodejs/working-with-files/",
-                  "/code/nodejs/async/",
-                ],
-              },
-              "/code/python/",
-              "/code/go/",
-              "/code/bash/",
-              "/destinations/",
-              "/scheduling-future-tasks/",
-            ],
-          },
-          {
-            title: "Authoring Components",
-            type: "group",
-            children: [
-              "/components/",
-              "/components/quickstart/nodejs/actions/",
-              "/components/quickstart/nodejs/sources/",
-              "/components/api/",
-              "/components/guidelines/",
-              "/pipedream-axios/",
-            ],
-          },
-          {
-            title: "CLI",
-            type: "group",
-            children: ["/cli/install/", "/cli/login/", "/cli/reference/"],
-          },
-          {
-            title: "APIs",
-            type: "group",
-            children: [
-              "/api/overview/",
-              "/api/auth/",
-              "/api/rest/",
-              "/api/rest/webhooks/",
-              "/api/rest/rss/",
-              "/api/rest/workflow-errors/",
-              "/api/sse/",
-            ],
-          },
-          {
-            title: "Integrations",
-            type: "group",
-            children: [
-              "/apps/all-apps/",
-              "/apps/discord/",
-              "/apps/hubspot/",
-              "/apps/servicenow/",
-              "/apps/slack/",
-              "/apps/strava/",
-              "/apps/twitter/",
-              "/apps/zoom/",
-            ],
-          },
-        ],
-      },
-      "/troubleshooting/",
-      {
-        title: "Privacy & Security",
-        children: [
-          "/privacy-and-security/",
-          "/privacy-and-security/best-practices/",
-          "/abuse/",
-          "/privacy-and-security/pgp-key/",
-          "/subprocessors/",
-        ],
-      },
-      {
-        title: "Pricing & Limits",
-        collapsable: true,
-        children: [
-          "/limits/",
-          "/pricing/",
-          "/workflows/events/cold-starts/",
-        ]
-      },
-      {
-        title: "Organizations",
-        collapsable: false,
-        children: ["/orgs/", "/orgs/sso/okta/"],
-      },
-      "/status/",
-      ["https://pipedream.com/support", "Need more help?"],
-    ],
-    PIPEDREAM_BASE_URL: "https://pipedream.com",
-    API_BASE_URL: "https://api.pipedream.com/v1",
-    SQL_API_BASE_URL: "https://rt.pipedream.com/sql",
-    PAYLOAD_SIZE_LIMIT: "512KB",
-    MEMORY_LIMIT: "256MB",
-    MEMORY_ABSOLUTE_LIMIT: "10GB",
-    EMAIL_PAYLOAD_SIZE_LIMIT: "30MB",
-    INSPECTOR_EVENT_LIMIT: "100",
-    FUNCTION_PAYLOAD_LIMIT: "6MB",
-    INSPECTOR_EVENT_EXPIRY_DAYS: "30",
-    DAILY_INVOCATIONS_LIMIT: "333",
-    FREE_ORG_DAILY_INVOCATIONS_LIMIT: "66",
-    PRICE_PER_INVOCATION: "0.0002",
-    FREE_MONTHLY_INVOCATIONS: "10,000",
-    PRO_MONTHLY_INVOCATIONS: "20,000",
-    TEAM_MONTHLY_INVOCATIONS: "20,000",
-    ENTERPRISE_MONTHLY_INVOCATIONS: "100,000",
-    TEAM_MEMBER_LIMIT: "5",
-    PRO_MONTHLY_PRICE: "$19",
-    TEAM_MONTHLY_PRICE: "$19",
-    DEFAULT_WORKFLOW_QUEUE_SIZE: "100",
-    MAX_WORKFLOW_QUEUE_SIZE: "10,000",
-    NODE_VERSION: "14",
-    PYTHON_VERSION: "3.8",
-    CONFIGURED_PROPS_SIZE_LIMIT: "64KB",
-    SERVICE_DB_SIZE_LIMIT: "60KB",
-    GO_LANG_VERSION: '1.17.1',
-    TMP_SIZE_LIMIT: '512MB',
-  },
+  themeConfig,
+  postcss: {
+    plugins: [require("autoprefixer"), require("tailwindcss")],
+  }
 };

docs/docs/.vuepress/configs/envVars.js

@@ -0,0 +1,29 @@
+module.exports = {
+  PIPEDREAM_BASE_URL: "https://pipedream.com",
+  API_BASE_URL: "https://api.pipedream.com/v1",
+  SQL_API_BASE_URL: "https://rt.pipedream.com/sql",
+  PAYLOAD_SIZE_LIMIT: "512KB",
+  MEMORY_LIMIT: "256MB",
+  MEMORY_ABSOLUTE_LIMIT: "10GB",
+  EMAIL_PAYLOAD_SIZE_LIMIT: "30MB",
+  INSPECTOR_EVENT_LIMIT: "100",
+  FUNCTION_PAYLOAD_LIMIT: "6MB",
+  INSPECTOR_EVENT_EXPIRY_DAYS: "30",
+  DAILY_INVOCATIONS_LIMIT: "333",
+  FREE_ORG_DAILY_INVOCATIONS_LIMIT: "66",
+  PRICE_PER_INVOCATION: "0.0002",
+  FREE_MONTHLY_INVOCATIONS: "10,000",
+  PRO_MONTHLY_INVOCATIONS: "20,000",
+  TEAM_MONTHLY_INVOCATIONS: "20,000",
+  ENTERPRISE_MONTHLY_INVOCATIONS: "100,000",
+  TEAM_MEMBER_LIMIT: "5",
+  PRO_MONTHLY_PRICE: "$19",
+  TEAM_MONTHLY_PRICE: "$19",
+  DEFAULT_WORKFLOW_QUEUE_SIZE: "100",
+  MAX_WORKFLOW_QUEUE_SIZE: "10,000",
+  NODE_VERSION: "14",
+  PYTHON_VERSION: "3.8",
+  CONFIGURED_PROPS_SIZE_LIMIT: "64KB",
+  SERVICE_DB_SIZE_LIMIT: "60KB",
+  TMP_SIZE_LIMIT: "512MB",
+}