feat: added apisix-python-plugin-runner (#558)

apache · Sep 7, 2021 · 7e051b2 · 7e051b2
1 parent bb734d5
commit 7e051b2
Show file tree

Hide file tree

Showing 7 changed files with 68 additions and 1 deletion.
diff --git a/scripts/common.js b/scripts/common.js
@@ -48,6 +48,14 @@ const projects = [
     changelogExtractor: function (changelogs, targetRelease) {
       return changelogExtractor(changelogs, targetRelease, "##", true);
     }
+  },
+  {
+    name: "apisix-python-plugin-runner",
+    branch: "master",
+    hasChangelog: true,
+    changelogExtractor: function (changelogs, targetRelease) {
+      return changelogExtractor(changelogs, targetRelease, "##", true);
+    }
   }
 ];
 

diff --git a/website/docs/apisix-python-plugin-runner/IGNORE_DOC.md b/website/docs/apisix-python-plugin-runner/IGNORE_DOC.md
diff --git a/website/docs/apisix-python-plugin-runner/sidebars.json b/website/docs/apisix-python-plugin-runner/sidebars.json
@@ -0,0 +1,3 @@
+{
+  "docs": {}
+}
diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -92,6 +92,17 @@ module.exports = {
         version: "0.2.0",
         releaseDate: "2021-09-03",
         firstDocPath: "/getting-started",
+      },
+      {
+        name: "APISIX® Python Plugin Runner",
+        nameInParamCase: "python-plugin-runner",
+        description: "Runs Apache APISIX plugins written in Python. Implemented as a sidecar that accompanies Apache APISIX.",
+        shape: "shield",
+        color: "#1296DB",
+        githubRepo: "apache/apisix-python-plugin-runner",
+        version: "0.1.0",
+        releaseDate: "2021-09-03",
+        firstDocPath: "/getting-started",
       }
     ],
     downloads: [
@@ -160,6 +171,19 @@ module.exports = {
         version: "0.2.0",
         releaseDate: "2021-09-03",
         firstDocPath: "/getting-started",
+      },
+      {
+        name: "APISIX® Python Plugin Runner",
+        nameInParamCase: "python-plugin-runner",
+        description: "Runs Apache APISIX plugins written in Python. Implemented as a sidecar that accompanies Apache APISIX.",
+        shape: "shield",
+        color: "#1296DB",
+        githubRepo: "apache/apisix-python-plugin-runner",
+        githubBranch: "master",
+        downloadPath: "apisix/python-plugin-runner/0.1.0/apisix-python-plugin-runner-0.1.0-src",
+        version: "0.1.0",
+        releaseDate: "2021-09-06",
+        firstDocPath: "/getting-started",
       }
     ],
 
@@ -175,7 +199,8 @@ module.exports = {
       "apache/apisix-helm-chart",
       "apache/apisix-control-plane",
       "apache/apisix-java-plugin-runner",
-      "apache/apisix-go-plugin-runner"
+      "apache/apisix-go-plugin-runner",
+      "apache/apisix-python-plugin-runner"
     ],
   },
   i18n: {
@@ -398,6 +423,26 @@ module.exports = {
         },
       },
     ],
+    [
+      "@docusaurus/plugin-content-docs",
+      {
+        id: "docs-apisix-python-plugin-runner",
+        path: "docs/apisix-python-plugin-runner",
+        showLastUpdateAuthor: true,
+        showLastUpdateTime: true,
+        routeBasePath: "/docs/python-plugin-runner",
+        sidebarPath: require.resolve("./docs/apisix-python-plugin-runner/sidebars.json"),
+        editUrl: function ({
+                             locale,
+                             version,
+                             versionDocsDirPath,
+                             docPath,
+                             permalink,
+                           }) {
+          return `https://github.com/apache/apisix-python-plugin-runner/edit/master/docs/en/latest/${docPath}`;
+        },
+      },
+    ],
   ],
   themeConfig: {
     navbar: {
@@ -440,6 +485,10 @@ module.exports = {
               label: "Apache APISIX®️ Go Plugin Runner",
               to: "/docs/go-plugin-runner/getting-started/"
             },
+            {
+              label: "Apache APISIX®️ Python Plugin Runner",
+              to: "/docs/python-plugin-runner/getting-started/"
+            },
             {
               label: "General",
               to: "/docs/general/security",

diff --git a/website/src/assets/icons/shield.svg b/website/src/assets/icons/shield.svg
diff --git a/website/src/pages/docs.js b/website/src/pages/docs.js
@@ -11,6 +11,7 @@ import IconPentagon from "../assets/icons/pentagon.svg";
 import IconDiamond from "../assets/icons/diamond.svg";
 import IconStar from "../assets/icons/star-solid.svg";
 import IconOctagon from "../assets/icons/octagon.svg";
+import IconShield from "../assets/icons/shield.svg";
 
 const Page = styled.div`
   max-width: var(--ifm-container-width);
@@ -127,6 +128,8 @@ const ProjectCard = (props) => {
       <IconHexagon />
     ) : shape === "star" ? (
       <IconStar />
+    ) : shape === "shield" ? (
+      <IconShield />
     ) : (
       <IconOctagon />
     );

diff --git a/website/src/pages/downloads/ProjectCard.js b/website/src/pages/downloads/ProjectCard.js
@@ -11,6 +11,7 @@ import IconSquare from "../../assets/icons/square.svg";
 import IconHexagon from "../../assets/icons/hexagon.svg";
 import IconStarSolid from "../../assets/icons/star-solid.svg";
 import IconOctagon from "../../assets/icons/octagon.svg";
+import IconShield from "../../assets/icons/shield.svg";
 
 const Dropdown = (props) => {
   const ref = useRef();
@@ -54,6 +55,8 @@ const ProjectCard = (props) => {
       <IconHexagon />
     ) : shape === "star" ? (
       <IconStarSolid />
+    ) : shape === "shield" ? (
+        <IconShield />
     ) : (
       <IconOctagon />
     );