feat: add Go Plugin Runner docs (#400)

Co-authored-by: 琚致远 <[email protected]>
apache · Jul 6, 2021 · 662ab8d · 662ab8d
1 parent 237cf26
commit 662ab8d
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 1 deletion.
diff --git a/common.js b/common.js
@@ -17,6 +17,9 @@ const projects = [
   }, {
     name: "apisix-java-plugin-runner",
     branch: "main"
+  }, {
+    name: "apisix-go-plugin-runner",
+    branch: "master"
   }
 ];
 

diff --git a/website/docs/apisix-go-plugin-runner/IGNORE_DOC.md b/website/docs/apisix-go-plugin-runner/IGNORE_DOC.md
@@ -0,0 +1 @@
+# IGNORE_DOC
diff --git a/website/docs/apisix-go-plugin-runner/sidebars.json b/website/docs/apisix-go-plugin-runner/sidebars.json
@@ -0,0 +1,3 @@
+{
+  "docs": {}
+}
diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -81,6 +81,17 @@ module.exports = {
         version: "0.1.0",
         releaseDate: "2021-06-23",
         firstDocPath: "/development",
+      },
+      {
+        name: "APISIX™ Go Plugin Runner",
+        nameInParamCase: "go-plugin-runner",
+        description: "Runs Apache APISIX plugins written in Go. Implemented as a sidecar that accompanies Apache APISIX.",
+        shape: "nonagon",
+        color: "#FB9300",
+        githubRepo: "apache/apisix-go-plugin-runner",
+        version: "0.1.0",
+        releaseDate: "2021-07-6",
+        firstDocPath: "/getting-started",
       }
     ],
     downloads: [
@@ -129,7 +140,8 @@ module.exports = {
       "apache/apisix-ingress-controller",
       "apache/apisix-helm-chart",
       "apache/apisix-control-plane",
-      "apache/apisix-java-plugin-runner"
+      "apache/apisix-java-plugin-runner",
+      "apache/apisix-go-plugin-runner"
     ],
   },
   i18n: {
@@ -307,6 +319,26 @@ module.exports = {
         },
       },
     ],
+    [
+      "@docusaurus/plugin-content-docs",
+      {
+        id: "docs-apisix-go-plugin-runner",
+        path: "docs/apisix-go-plugin-runner",
+        showLastUpdateAuthor: true,
+        showLastUpdateTime: true,
+        routeBasePath: "/docs/go-plugin-runner",
+        sidebarPath: require.resolve("./docs/apisix-go-plugin-runner/sidebars.json"),
+        editUrl: function ({
+          locale,
+          version,
+          versionDocsDirPath,
+          docPath,
+          permalink,
+        }) {
+          return `https://github.com/apache/apisix-go-plugin-runner/edit/master/docs/en/latest/${docPath}`;
+        },
+      },
+    ],
   ],
   themeConfig: {
     navbar: {
@@ -345,6 +377,10 @@ module.exports = {
               label: "Apache™️ APISIX Java Plugin Runner",
               to: "/docs/java-plugin-runner/development/"
             },
+            {
+              label: "Apache™️ APISIX Go Runner",
+              to: "/docs/go-plugin-runner/getting-started/"
+            },
             {
               label: "General",
               to: "/docs/general/security",