This is an automated email from the ASF dual-hosted git repository.
juzhiyuan pushed a commit to branch fix-docs-config
in repository https://gitbox.apache.org/repos/asf/apisix-ingress-controller.git
The following commit(s) were added to refs/heads/fix-docs-config by this push:
new dc145ef docs: update config
dc145ef is described below
commit dc145efb84453853b43fd603d1170041c8bd72bf
Author: juzhiyuan <[email protected]>
AuthorDate: Thu Feb 25 16:28:11 2021 +0800
docs: update config
---
docs/en/latest/CRD-specification.md | 9 ++++++---
docs/en/latest/FAQ.md | 6 ++++--
docs/en/latest/contribute.md | 6 ++++--
docs/en/latest/deployments/ack.md | 6 ++++--
docs/en/latest/deployments/aws.md | 6 ++++--
docs/en/latest/deployments/azure.md | 6 ++++--
docs/en/latest/deployments/gke.md | 6 ++++--
docs/en/latest/deployments/k3s-rke.md | 6 ++++--
docs/en/latest/deployments/kubesphere.md | 6 ++++--
docs/en/latest/deployments/minikube.md | 6 ++++--
docs/en/latest/deployments/tke.md | 6 ++++--
docs/en/latest/design.md | 6 ++++--
docs/en/latest/development.md | 6 ++++--
docs/en/latest/samples/index.md | 6 ++++--
docs/en/latest/samples/proxy-the-httpbin-service-with-ingress.md | 6 ++++--
docs/en/latest/samples/proxy-the-httpbin-service.md | 6 ++++--
docs/en/latest/usage.md | 6 ++++--
17 files changed, 70 insertions(+), 35 deletions(-)
diff --git a/docs/en/latest/CRD-specification.md
b/docs/en/latest/CRD-specification.md
index c63450a..c694350 100644
--- a/docs/en/latest/CRD-specification.md
+++ b/docs/en/latest/CRD-specification.md
@@ -1,3 +1,7 @@
+---
+title: CRD specification
+---
+
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,16 +21,15 @@
#
-->
-# CRD specification
-
In order to control the behavior of the proxy ([Apache
APISIX](https://github.com/apache/apisix)), the following CRDs should be
defined.
## CRD Types
+- [CRD Types](#crd-types)
- [ApisixRoute](#apisixroute)
- [ApisixUpstream](#apisixupstream)
- [Configuring Load Balancer](#configuring-load-balancer)
- - [Configuring Health Check](#configuring-load-balancer)
+ - [Configuring Health Check](#configuring-health-check)
- [Configuring Retry and Timeout](#configuring-retry-and-timeout)
- [Port Level Settings](#port-level-settings)
- [Configuration References](#configuration-references)
diff --git a/docs/en/latest/FAQ.md b/docs/en/latest/FAQ.md
index d90b272..cfe217e 100644
--- a/docs/en/latest/FAQ.md
+++ b/docs/en/latest/FAQ.md
@@ -1,3 +1,7 @@
+---
+title: FAQ
+---
+
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
#
-->
-# FAQ
-
1. How to bind Service and Upstream?
All resource objects are uniquely determined by the namespace / name / port
combination Id. If the combined Id is the same, the `service` and `upstream`
will be considered as a binding relationship.
diff --git a/docs/en/latest/contribute.md b/docs/en/latest/contribute.md
index 943fb5e..fa861ee 100644
--- a/docs/en/latest/contribute.md
+++ b/docs/en/latest/contribute.md
@@ -1,3 +1,7 @@
+---
+title: Contributing to apisix-ingress-controller
+---
+
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
#
-->
-# 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
contributing.
diff --git a/docs/en/latest/deployments/ack.md
b/docs/en/latest/deployments/ack.md
index f46238c..6f57d8a 100644
--- a/docs/en/latest/deployments/ack.md
+++ b/docs/en/latest/deployments/ack.md
@@ -1,3 +1,7 @@
+---
+title: Install Ingress APISIX on ACK
+---
+
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
#
-->
-# Install Ingress APISIX on ACK
-
This document explains how to install Ingress APISIX on [ali-cloud
ACK](https://www.aliyun.com/product/kubernetes).
## Prerequisites
diff --git a/docs/en/latest/deployments/aws.md
b/docs/en/latest/deployments/aws.md
index 34ba842..a0b10df 100644
--- a/docs/en/latest/deployments/aws.md
+++ b/docs/en/latest/deployments/aws.md
@@ -1,3 +1,7 @@
+---
+title: Install Ingress APISIX on Amazon EKS
+---
+
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
#
-->
-# 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
diff --git a/docs/en/latest/deployments/azure.md
b/docs/en/latest/deployments/azure.md
index 4dc6dba..11d12f3 100644
--- a/docs/en/latest/deployments/azure.md
+++ b/docs/en/latest/deployments/azure.md
@@ -1,3 +1,7 @@
+---
+title: Install Ingress APISIX on Azure AKS
+---
+
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
#
-->
-# 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
diff --git a/docs/en/latest/deployments/gke.md
b/docs/en/latest/deployments/gke.md
index cd03a1c..55730bd 100644
--- a/docs/en/latest/deployments/gke.md
+++ b/docs/en/latest/deployments/gke.md
@@ -1,3 +1,7 @@
+---
+title: Install Ingress APISIX on Google Cloud GKE
+---
+
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
#
-->
-# 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
diff --git a/docs/en/latest/deployments/k3s-rke.md
b/docs/en/latest/deployments/k3s-rke.md
index b45c907..c29cda0 100644
--- a/docs/en/latest/deployments/k3s-rke.md
+++ b/docs/en/latest/deployments/k3s-rke.md
@@ -1,3 +1,7 @@
+---
+title: Install Ingress APISIX on K3S and Rancher RKE
+---
+
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
#
-->
-# 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/).
K3S is a certified Kubernetes distribution built for IoT and Edge computing,
whilst [Apache APISIX](https://apisix.apache.org) is also good at IoT (See
[MQTT
plugin](https://github.com/apache/apisix/blob/master/doc/plugins/mqtt-proxy.md))
and runs well on ARM architecture.
diff --git a/docs/en/latest/deployments/kubesphere.md
b/docs/en/latest/deployments/kubesphere.md
index 3d15bae..00df343 100644
--- a/docs/en/latest/deployments/kubesphere.md
+++ b/docs/en/latest/deployments/kubesphere.md
@@ -1,3 +1,7 @@
+---
+title: Install Ingress APISIX on KubeSphere
+---
+
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
#
-->
-# 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.
diff --git a/docs/en/latest/deployments/minikube.md
b/docs/en/latest/deployments/minikube.md
index 3454102..7703914 100644
--- a/docs/en/latest/deployments/minikube.md
+++ b/docs/en/latest/deployments/minikube.md
@@ -1,3 +1,7 @@
+---
+title: Install Ingress APISIX on Minikube
+---
+
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
#
-->
-# Install Ingress APISIX on Minikube
-
This document explains how to install Ingress APISIX on
[Minikube](https://minikube.sigs.k8s.io/).
## Prerequisites
diff --git a/docs/en/latest/deployments/tke.md
b/docs/en/latest/deployments/tke.md
index 97fa0e5..b5b1c9c 100644
--- a/docs/en/latest/deployments/tke.md
+++ b/docs/en/latest/deployments/tke.md
@@ -1,3 +1,7 @@
+---
+title: Install Ingress APISIX on Tencent TKE
+---
+
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
#
-->
-# Install Ingress APISIX on Tencent TKE
-
This document explains how to install Ingress APISIX on [Tencent
TKE](https://cloud.tencent.com/product/tke).
## Prerequisites
diff --git a/docs/en/latest/design.md b/docs/en/latest/design.md
index a615464..533fff9 100644
--- a/docs/en/latest/design.md
+++ b/docs/en/latest/design.md
@@ -1,3 +1,7 @@
+---
+title: Ingress Controller
+---
+
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
#
-->
-# ingress-controller
-
Apache APISIX ingress for Kubernetes.
## Modules
diff --git a/docs/en/latest/development.md b/docs/en/latest/development.md
index 8d883d2..ddf109a 100644
--- a/docs/en/latest/development.md
+++ b/docs/en/latest/development.md
@@ -1,3 +1,7 @@
+---
+title: Developing for Apache APISIX Ingress Controller
+---
+
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
#
-->
-# Developing for Apache APISIX Ingress Controller
-
This document explains how to get started with developing for Apache APISIX
Ingress controller.
## Prerequisites
diff --git a/docs/en/latest/samples/index.md b/docs/en/latest/samples/index.md
index dd80f68..28dcbb5 100644
--- a/docs/en/latest/samples/index.md
+++ b/docs/en/latest/samples/index.md
@@ -1,3 +1,7 @@
+---
+title: Ingress APISIX Use Examples
+---
+
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
#
-->
-# Ingress APISIX Use Examples
-
This is an index page about use examples of Ingress APISIX. Read them if
you're trying to learn Ingress APISIX.
* [Proxy the httpbin service](./proxy-the-httpbin-service.md).
diff --git a/docs/en/latest/samples/proxy-the-httpbin-service-with-ingress.md
b/docs/en/latest/samples/proxy-the-httpbin-service-with-ingress.md
index 0012b78..a6ee906 100644
--- a/docs/en/latest/samples/proxy-the-httpbin-service-with-ingress.md
+++ b/docs/en/latest/samples/proxy-the-httpbin-service-with-ingress.md
@@ -1,3 +1,7 @@
+---
+title: Proxy the httpbin service with Ingress
+---
+
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
#
-->
-# Proxy the httpbin service
-
This document explains how apisix-ingress-controller guides Apache APISIX
routes traffic to httpbin service correctly by the [Kubernetes
Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/).
## Prerequisites
diff --git a/docs/en/latest/samples/proxy-the-httpbin-service.md
b/docs/en/latest/samples/proxy-the-httpbin-service.md
index a9e143b..9f60106 100644
--- a/docs/en/latest/samples/proxy-the-httpbin-service.md
+++ b/docs/en/latest/samples/proxy-the-httpbin-service.md
@@ -1,3 +1,7 @@
+---
+title: Proxy the httpbin service
+---
+
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
#
-->
-# Proxy the httpbin service
-
This document explains how apisix-ingress-controller guides Apache APISIX
routes traffic to httpbin service correctly.
## Prerequisites
diff --git a/docs/en/latest/usage.md b/docs/en/latest/usage.md
index 79a887f..89a2edc 100644
--- a/docs/en/latest/usage.md
+++ b/docs/en/latest/usage.md
@@ -1,3 +1,7 @@
+---
+title: Usage of Ingress controller
+---
+
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
#
-->
-# Usage of Ingress controller
-
In this article, we will use ingress controller CRDs
(CustomResourceDefinition) to define routing rules against the admin api of
Apache APISIX.
## Scenes
