docs: added meta info (apache#269)

goodrain · Feb 25, 2021 · c30636c · c30636c
1 parent 6d926db
commit c30636c
Show file tree

Hide file tree

Showing 19 changed files with 341 additions and 205 deletions.
diff --git a/.markdownlint.yml b/.markdownlint.yml
@@ -30,6 +30,8 @@ MD033: false
 # MD036/no-emphasis-as-heading/no-emphasis-as-header Emphasis used instead of a heading
 MD036: false
 
+MD041: false
+
 # MD024
 no-duplicate-heading:
   siblings_only: true
diff --git a/docs/en/latest/CRD-specification.md b/docs/en/latest/CRD-specification.md
diff --git a/docs/en/latest/FAQ.md b/docs/en/latest/FAQ.md
@@ -17,7 +17,12 @@
 #
 -->
 
-# FAQ
+---
+
+id: faq
+title: FAQ
+
+---
 
 1. How to bind Service and Upstream?
 

diff --git a/docs/en/latest/config.json b/docs/en/latest/config.json
@@ -1,4 +1,51 @@
 {
   "version": "0.3.0",
-  "sidebar": {}
+  "sidebar": {
+    "docs": [
+      {
+        "type": "category",
+        "label": "Getting Started",
+        "items": ["design", "crd-specification"]
+      },
+      {
+        "type": "category",
+        "label": "Samples",
+        "items": [
+          "samples",
+          "samples-proxy-the-httpbin-service-with-ingress",
+          "samples-proxy-the-httpbin-service"
+        ]
+      },
+      {
+        "type": "category",
+        "label": "Deployment",
+        "items": [
+          "deployment-on-ack",
+          "deployment-on-aws",
+          "deployment-on-azure-aks",
+          "deployment-on-gke",
+          "deployment-on-k3s-rke",
+          "deployment-on-kubeSphere",
+          "deployment-on-minikube",
+          "deployment-on-tke"
+        ]
+      },
+      {
+        "type": "doc",
+        "id": "usage"
+      },
+      {
+        "type": "doc",
+        "id": "development"
+      },
+      {
+        "type": "doc",
+        "id": "contributing"
+      },
+      {
+        "type": "doc",
+        "id": "faq"
+      }
+    ]
+  }
 }
diff --git a/docs/en/latest/contribute.md b/docs/en/latest/contribute.md
@@ -17,7 +17,12 @@
 #
 -->
 
-# Contributing to apisix-ingress-controller
+---
+
+id: contributing
+title: Contributing to apisix-ingress-controller
+
+---
 
 Firstly, thanks for your interest in contributing! I hope that this will be a
 pleasant first experience for you, and that you will return to continue
@@ -29,21 +34,21 @@ Most of the contributions that we receive are code contributions, but you can
 also contribute to the documentation or simply report solid bugs
 for us to fix.
 
- For new contributors, please take a look at issues with a tag called [Good first issue](https://github.com/apache/apisix-ingress-controller/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or [Help wanted](https://github.com/apache/apisix-ingress-controller/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22).
+For new contributors, please take a look at issues with a tag called [Good first issue](https://github.com/apache/apisix-ingress-controller/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or [Help wanted](https://github.com/apache/apisix-ingress-controller/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22).
 
 ## How to report a bug
 
-* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/apache/apisix-ingress-controller/issues).
+- **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/apache/apisix-ingress-controller/issues).
 
-* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/apache/apisix-ingress-controller/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/apache/apisix-ingress-controller/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
 
 ## How to add a new feature or change an existing one
 
 Before making any significant changes, please [open an issue](https://github.com/apache/apisix-ingress-controller/issues). Discussing your proposed changes ahead of time will make the contribution process smooth for everyone.
 
 Once we've discussed your changes and you've got your code ready, make sure that tests are passing and open your pull request. Your PR is most likely to be accepted if it:
 
-* Update the README.md with details of changes to the interface.
-* Includes tests for new functionality.
-* References the original issue in the description, e.g. "Resolves #123".
-* Has a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+- Update the README.md with details of changes to the interface.
+- Includes tests for new functionality.
+- References the original issue in the description, e.g. "Resolves #123".
+- Has a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
diff --git a/docs/en/latest/deployments/ack.md b/docs/en/latest/deployments/ack.md
@@ -17,17 +17,22 @@
 #
 -->
 
-# Install Ingress APISIX on ACK
+---
+
+id: deployment-on-ack
+title: Install Ingress APISIX on ACK
+
+---
 
 This document explains how to install Ingress APISIX on [ali-cloud ACK](https://www.aliyun.com/product/kubernetes).
 
 ## Prerequisites
 
-* Create an ACK Service on ali-cloud.
-* Download the kube config for your ACK, follow the [introduction](https://www.alibabacloud.com/help/zh/doc-detail/86378.html).
-* Install [Helm](https://helm.sh/).
-* Clone [Apache APISIX Charts](https://github.com/apache/apisix-helm-chart).
-* Make sure your target namespace exists, `kubectl` operations thorough this document will be executed in namespace `ingress-apisix`.
+- Create an ACK Service on ali-cloud.
+- Download the kube config for your ACK, follow the [introduction](https://www.alibabacloud.com/help/zh/doc-detail/86378.html).
+- Install [Helm](https://helm.sh/).
+- Clone [Apache APISIX Charts](https://github.com/apache/apisix-helm-chart).
+- Make sure your target namespace exists, `kubectl` operations thorough this document will be executed in namespace `ingress-apisix`.
 
 ## Install APISIX
 

diff --git a/docs/en/latest/deployments/aws.md b/docs/en/latest/deployments/aws.md
@@ -17,17 +17,22 @@
 #
 -->
 
-# Install Ingress APISIX on Amazon EKS
+---
+
+id: deployment-aws
+title: Install Ingress APISIX on Amazon EKS
+
+---
 
 This document explains how to install Ingress APISIX on [Amazon EKS](https://amazonaws-china.com/eks/?whats-new-cards.sort-by=item.additionalFields.postDateTime&whats-new-cards.sort-order=desc&eks-blogs.sort-by=item.additionalFields.createdDate&eks-blogs.sort-order=desc).
 
 ## Prerequisites
 
-* Create an EKS Service on AWS.
-* Install [Helm](https://helm.sh/).
-* Download the kube config for your EKS from [aws cli interface](https://amazonaws-china.com/cli/).
-* Clone [Apache APISIX Charts](https://github.com/apache/apisix-helm-chart).
-* Make sure your target namespace exists, kubectl operations thorough this document will be executed in namespace `ingress-apisix`.
+- Create an EKS Service on AWS.
+- Install [Helm](https://helm.sh/).
+- Download the kube config for your EKS from [aws cli interface](https://amazonaws-china.com/cli/).
+- Clone [Apache APISIX Charts](https://github.com/apache/apisix-helm-chart).
+- Make sure your target namespace exists, kubectl operations thorough this document will be executed in namespace `ingress-apisix`.
 
 ## Install APISIX
 

diff --git a/docs/en/latest/deployments/azure.md b/docs/en/latest/deployments/azure.md
@@ -17,17 +17,24 @@
 #
 -->
 
-# Install Ingress APISIX on Azure AKS
+---
 
-This document explains how to install Ingress APISIX on [Auzre AKS](https://docs.microsoft.com/en-us/azure/aks/intro-kubernetes#:~:text=Azure%20Kubernetes%20Service%20(AKS)%20makes,managed%20Kubernetes%20cluster%20in%20Azure.&text=The%20Kubernetes%20masters%20are%20managed,clusters%2C%20not%20for%20the%20masters.).
+id: deployment-azure-aks
+title: Install Ingress APISIX on Azure AKS
+
+---
+
+#
+
+This document explains how to install Ingress APISIX on [Auzre AKS](<https://docs.microsoft.com/en-us/azure/aks/intro-kubernetes#:~:text=Azure%20Kubernetes%20Service%20(AKS)%20makes,managed%20Kubernetes%20cluster%20in%20Azure.&text=The%20Kubernetes%20masters%20are%20managed,clusters%2C%20not%20for%20the%20masters.>).
 
 ## Prerequisites
 
-* Create an Kubernetes Service on Azure.
-* Install [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/#:~:text=The%20Azure%20command%2Dline%20interface,with%20an%20emphasis%20on%20automation.) and download the credentials by running `az aks get-credentials`.
-* Install [Helm](https://helm.sh/).
-* Clone [Apache APISIX Charts](https://github.com/apache/apisix-helm-chart).
-* Make sure your target namespace exists, kubectl operations thorough this document will be executed in namespace `ingress-apisix`.
+- Create an Kubernetes Service on Azure.
+- Install [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/#:~:text=The%20Azure%20command%2Dline%20interface,with%20an%20emphasis%20on%20automation.) and download the credentials by running `az aks get-credentials`.
+- Install [Helm](https://helm.sh/).
+- Clone [Apache APISIX Charts](https://github.com/apache/apisix-helm-chart).
+- Make sure your target namespace exists, kubectl operations thorough this document will be executed in namespace `ingress-apisix`.
 
 ## Install APISIX
 

diff --git a/docs/en/latest/deployments/gke.md b/docs/en/latest/deployments/gke.md
@@ -17,17 +17,22 @@
 #
 -->
 
-# Install Ingress APISIX on Google Cloud GKE
+---
+
+id: deployment-on-gke
+title: Install Ingress APISIX on Google Cloud GKE
+
+---
 
 This document explains how to install Ingress APISIX on [Google Cloud GKE](https://cloud.google.com/kubernetes-engine).
 
 ## Prerequisites
 
-* Create an Kubernetes Service on GKE.
-* Install [Google Cloud SDK](https://cloud.google.com/sdk) and get the credentials or you can just use the [Cloud Shell](https://cloud.google.com/shell).
-* Install [Helm](https://helm.sh/).
-* Clone [Apache APISIX Charts](https://github.com/apache/apisix-helm-chart).
-* Make sure your target namespace exists, kubectl operations thorough this document will be executed in namespace `ingress-apisix`.
+- Create an Kubernetes Service on GKE.
+- Install [Google Cloud SDK](https://cloud.google.com/sdk) and get the credentials or you can just use the [Cloud Shell](https://cloud.google.com/shell).
+- Install [Helm](https://helm.sh/).
+- Clone [Apache APISIX Charts](https://github.com/apache/apisix-helm-chart).
+- Make sure your target namespace exists, kubectl operations thorough this document will be executed in namespace `ingress-apisix`.
 
 ## Install APISIX
 

diff --git a/docs/en/latest/deployments/k3s-rke.md b/docs/en/latest/deployments/k3s-rke.md
@@ -17,7 +17,12 @@
 #
 -->
 
-# Install Ingress APISIX on K3S and Rancher RKE
+---
+
+id: deployment-on-k3s-rke
+title: Install Ingress APISIX on K3S and Rancher RKE
+
+---
 
 This document explains how to install Ingress APISIX on [k3S](https://k3s.io/) and [Rancher RKE](https://rancher.com/products/rke/).
 
@@ -26,10 +31,10 @@ It's a good choice to use Ingress APISIX as the north-south API gateway in K3S.
 
 ## Prerequisites
 
-* Install [K3S](https://rancher.com/docs/k3s/latest/en/installation/) or [Rancher RKE](https://rancher.com/docs/rke/latest/en/installation/).
-* Install [Helm](https://helm.sh/).
-* Clone [Apache APISIX Charts](https://github.com/apache/apisix-helm-chart).
-* Make sure your target namespace exists, kubectl operations thorough this document will be executed in namespace `ingress-apisix`.
+- Install [K3S](https://rancher.com/docs/k3s/latest/en/installation/) or [Rancher RKE](https://rancher.com/docs/rke/latest/en/installation/).
+- Install [Helm](https://helm.sh/).
+- Clone [Apache APISIX Charts](https://github.com/apache/apisix-helm-chart).
+- Make sure your target namespace exists, kubectl operations thorough this document will be executed in namespace `ingress-apisix`.
 
 ## Install APISIX
 
@@ -47,7 +52,7 @@ helm install apisix ./charts/apisix \
 kubectl get service --namespace ingress-apisix
 ```
 
-*If you are using K3S, the default kubeconfig file is in /etc/rancher/k3s and root permission may required.*
+_If you are using K3S, the default kubeconfig file is in /etc/rancher/k3s and root permission may required._
 
 Two Service resources were created, one is `apisix-gateway`, which processes the real traffic; another is `apisix-admin`, which acts as the control plane to process all the configuration changes.
 
@@ -71,7 +76,7 @@ helm install apisix-ingress-controller ./charts/apisix-ingress-controller \
   --kubeconfig /etc/rancher/k3s/k3s.yaml
 ```
 
-*If you are using K3S, the default kubeconfig file is in /etc/rancher/k3s and root permission may required.*
+_If you are using K3S, the default kubeconfig file is in /etc/rancher/k3s and root permission may required._
 
 The admin key used in abovementioned commands is the default one, if you change the admin key configuration when you deployed APISIX, please remember to change it here.
 

diff --git a/docs/en/latest/deployments/kubesphere.md b/docs/en/latest/deployments/kubesphere.md
@@ -17,18 +17,23 @@
 #
 -->
 
-# Install Ingress APISIX on KubeSphere
+---
+
+id: deployment-on-kubeSphere
+title: Install Ingress APISIX on KubeSphere
+
+---
 
 This document explains how to install Ingress APISIX on [KubeSphere](https://kubesphere.io/).
 
 KubeSphere is a distributed operating system managing cloud native applications with Kubernetes as its kernel, and provides plug-and-play architecture for the seamless integration of third-party applications to boost its ecosystem.
 
 ## Prerequisites
 
-* Install [KubeSphere](https://kubesphere.io/docs/quick-start/), you can choose [All-in-one Installation on Linux](https://kubesphere.io/docs/quick-start/all-in-one-on-linux/) or [Minimal KubeSphere on Kubernetes](https://kubesphere.io/docs/quick-start/minimal-kubesphere-on-k8s/).
-* Install [Helm](https://helm.sh/).
-* Clone [Apache APISIX Charts](https://github.com/apache/apisix-helm-chart).
-* Make sure your target namespace exists, kubectl operations of this document will be executed in namespace `ingress-apisix`.
+- Install [KubeSphere](https://kubesphere.io/docs/quick-start/), you can choose [All-in-one Installation on Linux](https://kubesphere.io/docs/quick-start/all-in-one-on-linux/) or [Minimal KubeSphere on Kubernetes](https://kubesphere.io/docs/quick-start/minimal-kubesphere-on-k8s/).
+- Install [Helm](https://helm.sh/).
+- Clone [Apache APISIX Charts](https://github.com/apache/apisix-helm-chart).
+- Make sure your target namespace exists, kubectl operations of this document will be executed in namespace `ingress-apisix`.
 
 ## Install APISIX
 

diff --git a/docs/en/latest/deployments/minikube.md b/docs/en/latest/deployments/minikube.md
@@ -17,16 +17,21 @@
 #
 -->
 
-# Install Ingress APISIX on Minikube
+---
+
+id: deployment-on-minikube
+title: Install Ingress APISIX on Minikube
+
+---
 
 This document explains how to install Ingress APISIX on [Minikube](https://minikube.sigs.k8s.io/).
 
 ## Prerequisites
 
-* Install [Minikube](https://minikube.sigs.k8s.io/docs/start/).
-* Install [Helm](https://helm.sh/).
-* Clone [Apache APISIX Charts](https://github.com/apache/apisix-helm-chart).
-* Make sure your target namespace exists, kubectl operations thorough this document will be executed in namespace `ingress-apisix`.
+- Install [Minikube](https://minikube.sigs.k8s.io/docs/start/).
+- Install [Helm](https://helm.sh/).
+- Clone [Apache APISIX Charts](https://github.com/apache/apisix-helm-chart).
+- Make sure your target namespace exists, kubectl operations thorough this document will be executed in namespace `ingress-apisix`.
 
 ## Install APISIX
 

diff --git a/docs/en/latest/deployments/tke.md b/docs/en/latest/deployments/tke.md
@@ -17,17 +17,22 @@
 #
 -->
 
-# Install Ingress APISIX on Tencent TKE
+---
+
+id: deployment-on-tke
+title: Install Ingress APISIX on Tencent TKE
+
+---
 
 This document explains how to install Ingress APISIX on [Tencent TKE](https://cloud.tencent.com/product/tke).
 
 ## Prerequisites
 
-* Create a TKE Service on Tencent Cloud and make sure the API Server is accessible from your workspace.
-* Install [Helm](https://helm.sh/).
-* Download the kube config for your TKE Console.
-* Clone [Apache APISIX Charts](https://github.com/apache/apisix-helm-chart).
-* Make sure your target namespace exists, kubectl operations thorough this document will be executed in namespace `ingress-apisix`.
+- Create a TKE Service on Tencent Cloud and make sure the API Server is accessible from your workspace.
+- Install [Helm](https://helm.sh/).
+- Download the kube config for your TKE Console.
+- Clone [Apache APISIX Charts](https://github.com/apache/apisix-helm-chart).
+- Make sure your target namespace exists, kubectl operations thorough this document will be executed in namespace `ingress-apisix`.
 
 ## Install APISIX
-Original file line number
+Diff line change
@@ Expand Up / @@ -17,7 +17,12 @@ @@
     #
     -->
-    # FAQ
+    ---
+    id: faq
+    title: FAQ
+    ---
 . How to bind Service and Upstream?
@@ Expand Down @@