This is an automated email from the ASF dual-hosted git repository.
tokers pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix-ingress-controller.git
The following commit(s) were added to refs/heads/master by this push:
new d8a40b7 docs: broken links in markdown files (#417)
d8a40b7 is described below
commit d8a40b7dfa49b844fd0159a4e0450c3066f24cfd
Author: Kishani Kandasamy <[email protected]>
AuthorDate: Sun May 2 15:05:55 2021 +0530
docs: broken links in markdown files (#417)
---
docs/en/latest/concepts/apisix_upstream.md | 2 +-
docs/en/latest/deployments/ack.md | 2 +-
docs/en/latest/deployments/aws.md | 2 +-
docs/en/latest/deployments/azure.md | 2 +-
docs/en/latest/deployments/gke.md | 2 +-
docs/en/latest/deployments/k3s-rke.md | 4 ++--
docs/en/latest/deployments/kubesphere.md | 2 +-
docs/en/latest/deployments/minikube.md | 2 +-
docs/en/latest/deployments/tke.md | 2 +-
docs/en/latest/design.md | 2 +-
docs/en/latest/development.md | 2 +-
docs/en/latest/getting-started.md | 4 ++--
docs/en/latest/practices/proxy-the-httpbin-service-with-ingress.md | 4 ++--
docs/en/latest/practices/proxy-the-httpbin-service.md | 6 +++---
docs/en/latest/references/apisix_upstream.md | 2 +-
15 files changed, 20 insertions(+), 20 deletions(-)
diff --git a/docs/en/latest/concepts/apisix_upstream.md
b/docs/en/latest/concepts/apisix_upstream.md
index 33fbbc5..da3f370 100644
--- a/docs/en/latest/concepts/apisix_upstream.md
+++ b/docs/en/latest/concepts/apisix_upstream.md
@@ -25,7 +25,7 @@ ApisixUpstream is the decorator of Kubernetes Service. It's
designed to have sam
load balancing, health check, retry, timeout parameters and etc.
Resort to `ApisixUpstream` and the Kubernetes Service, apisix ingress
controller will generates the APISIX Upstream(s).
-To learn more, please check the [Apache APISIX architecture-design
docs](https://github.com/apache/apisix/blob/master/doc/architecture-design.md#upstream).
+To learn more, please check the [Apache APISIX architecture-design
docs](https://github.com/apache/apisix/blob/master/docs/en/latest/architecture-design/upstream.md).
### Configuring Load Balancer
diff --git a/docs/en/latest/deployments/ack.md
b/docs/en/latest/deployments/ack.md
index 936a996..0a835dd 100644
--- a/docs/en/latest/deployments/ack.md
+++ b/docs/en/latest/deployments/ack.md
@@ -85,4 +85,4 @@ helm install apisix-ingress-controller
apisix/apisix-ingress-controller \
Change the `image.tag` to the apisix-ingress-controller version that you
desire. You have to Wait for while until the corresponding pods are running.
-Try to create some [resources](../CRD-specification.md) to verify the running
status. As a minimalist example, see
[proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn
how to apply resources to drive the apisix-ingress-controller.
+Try to create some
[resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts)
to verify the running status. As a minimalist example, see
[proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn
how to apply resources to drive the apisix-ingress-controller.
diff --git a/docs/en/latest/deployments/aws.md
b/docs/en/latest/deployments/aws.md
index 864d5ad..e7ca320 100644
--- a/docs/en/latest/deployments/aws.md
+++ b/docs/en/latest/deployments/aws.md
@@ -76,4 +76,4 @@ Change the `image.tag` to the apisix-ingress-controller
version that you desire.
Now open your [EKS console](https://console.aws.amazon.com/eks/home), choosing
your cluster and clicking the Workloads tag, you'll see all pods of Apache
APISIX, etcd and apisix-ingress-controller are ready.
-Try to create some [resources](../CRD-specification.md) to verify the running
status. As a minimalist example, see
[proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn
how to apply resources to drive the apisix-ingress-controller.
+Try to create some
[resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts)
to verify the running status. As a minimalist example, see
[proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn
how to apply resources to drive the apisix-ingress-controller.
diff --git a/docs/en/latest/deployments/azure.md
b/docs/en/latest/deployments/azure.md
index 1fcd74e..4560983 100644
--- a/docs/en/latest/deployments/azure.md
+++ b/docs/en/latest/deployments/azure.md
@@ -74,4 +74,4 @@ helm install apisix-ingress-controller
apisix/apisix-ingress-controller \
Change the `image.tag` to the apisix-ingress-controller version that you
desire. You have to wait for while until the corresponding pods are running.
-Now try to create some [resources](../CRD-specification.md) to verify the
running status. As a minimalist example, see
[proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn
how to apply resources to drive the apisix-ingress-controller.
+Now try to create some
[resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts)
to verify the running status. As a minimalist example, see
[proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn
how to apply resources to drive the apisix-ingress-controller.
diff --git a/docs/en/latest/deployments/gke.md
b/docs/en/latest/deployments/gke.md
index ed7102f..36afee4 100644
--- a/docs/en/latest/deployments/gke.md
+++ b/docs/en/latest/deployments/gke.md
@@ -74,4 +74,4 @@ helm install apisix-ingress-controller
apisix/apisix-ingress-controller \
Change the `image.tag` to the apisix-ingress-controller version that you
desire. You have to wait for while until the corresponding pods are running.
-Now try to create some [resources](../CRD-specification.md) to verify the
running status. As a minimalist example, see
[proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn
how to apply resources to drive the apisix-ingress-controller.
+Now try to create some
[resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts)
to verify the running status. As a minimalist example, see
[proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn
how to apply resources to drive the apisix-ingress-controller.
diff --git a/docs/en/latest/deployments/k3s-rke.md
b/docs/en/latest/deployments/k3s-rke.md
index 205db1c..b928988 100644
--- a/docs/en/latest/deployments/k3s-rke.md
+++ b/docs/en/latest/deployments/k3s-rke.md
@@ -23,7 +23,7 @@ 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/).
-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.
+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/docs/en/latest/plugins/mqtt-proxy.md))
and runs well on ARM architecture.
It's a good choice to use Ingress APISIX as the north-south API gateway in K3S.
## Prerequisites
@@ -81,4 +81,4 @@ The admin key used in above mentioned commands is the default
one, if you change
Change the `image.tag` to the apisix-ingress-controller version that you
desire. You have to wait for while until the corresponding pods are running.
-Now try to create some [resources](../CRD-specification.md) to verify the
running status. As a minimalist example, see
[proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn
how to apply resources to drive the apisix-ingress-controller.
+Now try to create some
[resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts)
to verify the running status. As a minimalist example, see
[proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn
how to apply resources to drive the apisix-ingress-controller.
diff --git a/docs/en/latest/deployments/kubesphere.md
b/docs/en/latest/deployments/kubesphere.md
index 1e855d1..fbeeefc 100644
--- a/docs/en/latest/deployments/kubesphere.md
+++ b/docs/en/latest/deployments/kubesphere.md
@@ -74,4 +74,4 @@ The admin key used above is the default one. If you change
the admin key configu
Change the `image.tag` to the apisix-ingress-controller version that you
desire. Wait for the corresponding pods are running.
-Now try to create some [resources](../CRD-specification.md) to verify the
running status. As a minimalist example, see
[proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn
how to apply resources to drive the apisix-ingress-controller.
+Now try to create some
[resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts)
to verify the running status. As a minimalist example, see
[proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn
how to apply resources to drive the apisix-ingress-controller.
diff --git a/docs/en/latest/deployments/minikube.md
b/docs/en/latest/deployments/minikube.md
index 4c551e1..e671cfa 100644
--- a/docs/en/latest/deployments/minikube.md
+++ b/docs/en/latest/deployments/minikube.md
@@ -66,4 +66,4 @@ helm install apisix-ingress-controller
apisix/apisix-ingress-controller \
Change the `image.tag` to the apisix-ingress-controller version that you
desire. You have to wait for while until the corresponding pods are running.
-Now try to create some [resources](../CRD-specification.md) to verify the
running of Ingress APISIX. As a minimalist example, see
[proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn
how to apply resources to drive the apisix-ingress-controller.
+Now try to create some
[resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts)
to verify the running of Ingress APISIX. As a minimalist example, see
[proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn
how to apply resources to drive the apisix-ingress-controller.
diff --git a/docs/en/latest/deployments/tke.md
b/docs/en/latest/deployments/tke.md
index fa5016d..92b1bef 100644
--- a/docs/en/latest/deployments/tke.md
+++ b/docs/en/latest/deployments/tke.md
@@ -79,4 +79,4 @@ Change the `image.tag` to the apisix-ingress-controller
version that you desire.
Now open your [TKE console](https://console.cloud.tencent.com/tke2/overview),
choosing your cluster and clicking the Workloads tag, you'll see all pods of
Apache APISIX, etcd and apisix-ingress-controller are ready.
-Try to create some [resources](../CRD-specification.md) to verify the running
status. As a minimalist example, see
[proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn
how to apply resources to drive the apisix-ingress-controller.
+Try to create some
[resources](https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/concepts)
to verify the running status. As a minimalist example, see
[proxy-the-httpbin-service](../practices/proxy-the-httpbin-service.md) to learn
how to apply resources to drive the apisix-ingress-controller.
diff --git a/docs/en/latest/design.md b/docs/en/latest/design.md
index 533fff9..4d51156 100644
--- a/docs/en/latest/design.md
+++ b/docs/en/latest/design.md
@@ -132,7 +132,7 @@ spec:
...
```
-The black and white list here is implemented by the
[ip-restriction](https://github.com/apache/apisix/blob/master/doc/plugins/ip-restriction.md)
plugin.
+The black and white list here is implemented by the
[ip-restriction](https://github.com/apache/apisix/blob/master/docs/en/latest/plugins/ip-restriction.md)
plugin.
There will be more annotation implementations in the future to facilitate the
definition of some common configurations, such as CORS.
diff --git a/docs/en/latest/development.md b/docs/en/latest/development.md
index be05107..014f25b 100644
--- a/docs/en/latest/development.md
+++ b/docs/en/latest/development.md
@@ -27,7 +27,7 @@ This document explains how to get started with developing for
Apache APISIX Ingr
* Install [Go 1.13](https://golang.org/dl/) or later, and we use go module to
manage the go package dependencies.
* Prepare an available Kubernetes cluster in your workstation, we recommend
you to use [Minikube](https://github.com/kubernetes/minikube).
-* [Install Apache APISIX in Kubernetes by Helm
Chart](https://github.com/apache/apisix-helm-chart).
+* Install Apache APISIX in Kubernetes by [Helm
Chart](https://github.com/apache/apisix-helm-chart).
## Fork and Clone
diff --git a/docs/en/latest/getting-started.md
b/docs/en/latest/getting-started.md
index f6fbb72..809403f 100644
--- a/docs/en/latest/getting-started.md
+++ b/docs/en/latest/getting-started.md
@@ -25,7 +25,7 @@ title: Getting Started
apisix-ingress-controller is yet another Ingress controller for Kubernetes
using [Apache APISIX](https://apisix.apache.org) as the high performance
reverse proxy.
-It's configured by using the declarative configurations like
[ApisixRoute](./concepts/apisix_route.md), [ApisixUpstream](./concepts/apisix),
[Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/).
+It's configured by using the declarative configurations like
[ApisixRoute](./concepts/apisix_route.md),
[ApisixUpstream](./concepts/apisix_upstream.md),
[Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/).
All these resources are watched and converted to corresponding resources in
Apache APISIX.
Service Discovery are also supported through [Kubernetes
Service](https://kubernetes.io/docs/concepts/services-networking/service/),
@@ -62,7 +62,7 @@ apisix-ingress-controller supports to be installed on some
clouds such as AWS, G
## Installation on Prem
-If you want to deploy apisix-ingress-controller on Prem, we recommend you to
use [Helm](https://helm.io). Just a few steps
+If you want to deploy apisix-ingress-controller on Prem, we recommend you to
use [Helm](https://helm.sh/). Just a few steps
## Get Involved to Contribute
diff --git a/docs/en/latest/practices/proxy-the-httpbin-service-with-ingress.md
b/docs/en/latest/practices/proxy-the-httpbin-service-with-ingress.md
index a6ee906..2615552 100644
--- a/docs/en/latest/practices/proxy-the-httpbin-service-with-ingress.md
+++ b/docs/en/latest/practices/proxy-the-httpbin-service-with-ingress.md
@@ -26,8 +26,8 @@ This document explains how apisix-ingress-controller guides
Apache APISIX routes
## Prerequisites
* Prepare an available Kubernetes cluster in your workstation, we recommend
you to use [Minikube](https://github.com/kubernetes/minikube).
-* [Install Apache APISIX in Kubernetes by Helm
Chart](https://github.com/apache/apisix-helm-chart).
-* Install
[apisix-ingress-controller](https://github.com/apache/apisix-ingress-controller/blob/master/docs/install.md).
+* Install Apache APISIX in Kubernetes by [Helm
Chart](https://github.com/apache/apisix-helm-chart).
+* Install
[apisix-ingress-controller](https://github.com/apache/apisix-ingress-controller/blob/master/install.md).
## Deploy httpbin service
diff --git a/docs/en/latest/practices/proxy-the-httpbin-service.md
b/docs/en/latest/practices/proxy-the-httpbin-service.md
index 9f60106..87ce38f 100644
--- a/docs/en/latest/practices/proxy-the-httpbin-service.md
+++ b/docs/en/latest/practices/proxy-the-httpbin-service.md
@@ -26,8 +26,8 @@ This document explains how apisix-ingress-controller guides
Apache APISIX routes
## Prerequisites
* Prepare an available Kubernetes cluster in your workstation, we recommend
you to use [Minikube](https://github.com/kubernetes/minikube).
-* [Install Apache APISIX in Kubernetes by Helm
Chart](https://github.com/apache/apisix-helm-chart).
-* Install
[apisix-ingress-controller](https://github.com/apache/apisix-ingress-controller/blob/master/docs/install.md).
+* Install Apache APISIX in Kubernetes by [Helm
Chart](https://github.com/apache/apisix-helm-chart).
+* Install
[apisix-ingress-controller](https://github.com/apache/apisix-ingress-controller/blob/master/install.md).
## Deploy httpbin service
@@ -42,7 +42,7 @@ kubectl expose pod httpbin --port 80
## Resource Delivery
-In order to let Apache APISIX proxies requests to httpbin, we need to create
an `ApisixRoute` resource, if you're not familiar with it, see the
[reference](https://github.com/apache/apisix-ingress-controller/blob/master/docs/CRD-specification.md#apisixroute)
for the details.
+In order to let Apache APISIX proxies requests to httpbin, we need to create
an `ApisixRoute` resource, if you're not familiar with it, see the
[reference](https://github.com/apache/apisix-ingress-controller/blob/master/samples/deploy/crd/v1beta1/ApisixRoute.yaml)
for the details.
```yaml
# httpbin-route.yaml
diff --git a/docs/en/latest/references/apisix_upstream.md
b/docs/en/latest/references/apisix_upstream.md
index cbbc26a..84ab1fe 100644
--- a/docs/en/latest/references/apisix_upstream.md
+++ b/docs/en/latest/references/apisix_upstream.md
@@ -33,7 +33,7 @@ title: ApisixUpstream Reference
| timeout.connect | time duration in the form "72h3m0.5s" | The connect
timeout. |
| timeout.read | time duration in the form "72h3m0.5s" | The read timeout. |
| timeout.send | time duration in the form "72h3m0.5s" | The send timeout. |
-| healthCheck | object | The health check parameters, see [Health
Check](https://github.com/apache/apisix/blob/master/doc/health-check.md) for
more details. |
+| healthCheck | object | The health check parameters, see [Health
Check](https://github.com/apache/apisix/blob/master/docs/en/latest/health-check.md)
for more details. |
| healthCheck.active | object | active health check configuration, which is a
mandatory field. |
| healthCheck.active.type | string | health check type, can be `http`, `https`
and `tcp`, default is `http`. |
| healthCheck.active.timeout | time duration in the form "72h3m0.5s" | the
timeout settings for the probe, default is `1s`. |
