You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by ju...@apache.org on 2021/05/16 15:31:52 UTC
[apisix-website] branch master updated: docs: include Helm charts
and Docker to documents page (#342)
This is an automated email from the ASF dual-hosted git repository.
juzhiyuan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix-website.git
The following commit(s) were added to refs/heads/master by this push:
new 1d575cd docs: include Helm charts and Docker to documents page (#342)
1d575cd is described below
commit 1d575cdab9737a10594faa709093600225fc3a7c
Author: Kishani Kandasamy <53...@users.noreply.github.com>
AuthorDate: Sun May 16 21:01:45 2021 +0530
docs: include Helm charts and Docker to documents page (#342)
---
website/docusaurus.config.js | 61 ++++++++++++++++++++++++++++++++++-
website/src/assets/icons/diamond.svg | 3 ++
website/src/assets/icons/pentagon.svg | 3 ++
website/src/pages/docs.js | 10 ++++--
4 files changed, 74 insertions(+), 3 deletions(-)
diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
index 7674291..9c2b403 100644
--- a/website/docusaurus.config.js
+++ b/website/docusaurus.config.js
@@ -14,13 +14,72 @@ module.exports = {
events: require("./static/data/events.json"),
repoUrl: "https://github.com/apache/apisix",
docsUrl: "",
+ docs: [
+ {
+ name: "APISIX™",
+ nameInParamCase: "apisix",
+ description: "A dynamic, real-time, high-performance API gateway.",
+ shape: "triangle",
+ color: "#e8433e",
+ githubRepo: "apache/apisix",
+ version: "2.5",
+ releaseDate: "2021-04-05",
+ firstDocPath: "/getting-started",
+ },
+ {
+ name: "APISIX™ Dashboard",
+ nameInParamCase: "dashboard",
+ description:
+ "Designed to make it as easy as possible for users to operate Apache APISIX through a frontend interface.",
+ shape: "square",
+ color: "#10B981",
+ githubRepo: "apache/apisix-dashboard",
+ version: "2.6",
+ releaseDate: "2021-04-22",
+ firstDocPath: "/USER_GUIDE",
+ },
+ {
+ name: "APISIX™ Ingress Controller",
+ nameInParamCase: "ingress-controller",
+ description: "An Apache APISIX control plane component.",
+ shape: "hexagon",
+ color: "#2563EB",
+ githubRepo: "apache/apisix-ingress-controller",
+ version: "0.5.0",
+ releaseDate: "2021-04-11",
+ firstDocPath: "/getting-started",
+ },
+ {
+ name: "APISIX™ Helm Charts",
+ nameInParamCase: "helm-chart",
+ description: "An Apache APISIX Helm Charts provide the installation of Apache APISIX components for kubernetes.",
+ shape: "pentagon",
+ color: "#C71585",
+ githubRepo: "apache/apisix-helm-chart",
+ version: "0.4.0",
+ releaseDate: "2021-03-12",
+ firstDocPath: "/apisix",
+ },
+ {
+ name: "APISIX™ Docker",
+ nameInParamCase: "docker",
+ description: "Docker tooling for Apache APISIX.",
+ shape: "diamond",
+ color: "#FFD700",
+ githubRepo: "apache/apisix-docker",
+ version: "1.0.0",
+ releaseDate: "2020-12-1",
+ firstDocPath: "/build",
+ }
+ ],
+
downloads: [
{
name: "APISIX™",
nameInParamCase: "apisix",
description: "A dynamic, real-time, high-performance API gateway.",
shape: "triangle",
- color: "var(--ifm-color-primary)",
+ color: "#e8433e",
githubRepo: "apache/apisix",
version: "2.5",
releaseDate: "2021-04-05",
diff --git a/website/src/assets/icons/diamond.svg b/website/src/assets/icons/diamond.svg
new file mode 100644
index 0000000..118571c
--- /dev/null
+++ b/website/src/assets/icons/diamond.svg
@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" fill="currentColor" class="bi bi-diamond-fill" viewBox="0 0 16 16">
+ <path fill-rule="evenodd" d="M6.95.435c.58-.58 1.52-.58 2.1 0l6.515 6.516c.58.58.58 1.519 0 2.098L9.05 15.565c-.58.58-1.519.58-2.098 0L.435 9.05a1.482 1.482 0 0 1 0-2.098L6.95.435z"/>
+</svg>
diff --git a/website/src/assets/icons/pentagon.svg b/website/src/assets/icons/pentagon.svg
new file mode 100644
index 0000000..2c14ab1
--- /dev/null
+++ b/website/src/assets/icons/pentagon.svg
@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" fill="currentColor" class="bi bi-pentagon-fill" viewBox="0 0 16 16">
+ <path d="m8 0 8 6.5-3 9.5H3L0 6.5 8 0z"/>
+</svg>
diff --git a/website/src/pages/docs.js b/website/src/pages/docs.js
index f0bbd0f..3af862b 100644
--- a/website/src/pages/docs.js
+++ b/website/src/pages/docs.js
@@ -7,6 +7,8 @@ import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
import IconTriangle from "../assets/icons/triangle.svg";
import IconSquare from "../assets/icons/square.svg";
import IconHexagon from "../assets/icons/hexagon.svg";
+import IconPentagon from "../assets/icons/pentagon.svg";
+import IconDiamond from "../assets/icons/diamond.svg";
const Page = styled.div`
max-width: var(--ifm-container-width);
@@ -113,6 +115,10 @@ const ProjectCard = (props) => {
const shapeComponent =
shape === "triangle" ? (
<IconTriangle />
+ ) : shape === "pentagon" ? (
+ <IconPentagon />
+ ) : shape === "diamond" ? (
+ <IconDiamond />
) : shape === "square" ? (
<IconSquare />
) : (
@@ -136,10 +142,10 @@ const ProjectCard = (props) => {
export default (props) => {
const { siteConfig } = useDocusaurusContext();
- if (!(siteConfig.customFields.downloads || []).length) {
+ if (!(siteConfig.customFields.docs || []).length) {
return null;
}
- const projects = siteConfig.customFields.downloads.map((project) => {
+ const projects = siteConfig.customFields.docs.map((project) => {
return <ProjectCard key={project.name} {...project} />;
});