From 34873ae4e5746e5595bd89be5fd6b0a9b05b74eb Mon Sep 17 00:00:00 2001 From: xuruidong Date: Sun, 18 Jun 2023 15:55:17 +0800 Subject: [PATCH] docs: replace some urls that point to github with relative paths --- docs/en/latest/building-apisix.md | 2 +- docs/en/latest/discovery/kubernetes.md | 6 +++--- docs/en/latest/plugin-develop.md | 2 +- docs/en/latest/plugins/elasticsearch-logger.md | 2 +- docs/zh/latest/README.md | 2 +- docs/zh/latest/building-apisix.md | 2 +- docs/zh/latest/discovery/kubernetes.md | 6 +++--- docs/zh/latest/plugin-develop.md | 2 +- docs/zh/latest/plugins/elasticsearch-logger.md | 2 +- 9 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/en/latest/building-apisix.md b/docs/en/latest/building-apisix.md index ad4f11c68df5..ef5b70c019f7 100644 --- a/docs/en/latest/building-apisix.md +++ b/docs/en/latest/building-apisix.md @@ -272,4 +272,4 @@ To run a specific test case, use the command below: prove -Itest-nginx/lib -r t/plugin/openid-connect.t ``` -See [testing framework](https://github.com/apache/apisix/blob/master/docs/en/latest/internal/testing-framework.md) for more details. +See [testing framework](./internal/testing-framework.md) for more details. diff --git a/docs/en/latest/discovery/kubernetes.md b/docs/en/latest/discovery/kubernetes.md index e062fd9e41fd..0735471b8145 100644 --- a/docs/en/latest/discovery/kubernetes.md +++ b/docs/en/latest/discovery/kubernetes.md @@ -32,7 +32,7 @@ description: This article introduce how to perform service discovery based on Ku The [_Kubernetes_](https://kubernetes.io/) service discovery [_List-Watch_](https://kubernetes.io/docs/reference/using-api/api-concepts/) real-time changes of [_Endpoints_](https://kubernetes.io/docs/concepts/services-networking/service/) resources, then store theirs value into `ngx.shared.DICT`. -Discovery also provides a node query interface in accordance with the [_APISIX Discovery Specification_](https://github.com/apache/apisix/blob/master/docs/en/latest/discovery.md). +Discovery also provides a node query interface in accordance with the [_APISIX Discovery Specification_](../discovery.md). :::note @@ -122,7 +122,7 @@ discovery: ### Single-Cluster Mode Query Interface -The Kubernetes service discovery provides a query interface in accordance with the [_APISIX Discovery Specification_](https://github.com/apache/apisix/blob/master/docs/en/latest/discovery.md). +The Kubernetes service discovery provides a query interface in accordance with the [_APISIX Discovery Specification_](../discovery.md). **function:** nodes(service_name) @@ -232,7 +232,7 @@ Multi-Kubernetes service discovery does not fill default values for service and ### Multi-Cluster Mode Query Interface -The Kubernetes service discovery provides a query interface in accordance with the [_APISIX Discovery Specification_](https://github.com/apache/apisix/blob/master/docs/en/latest/discovery.md). +The Kubernetes service discovery provides a query interface in accordance with the [_APISIX Discovery Specification_](../discovery.md). **function:** nodes(service_name) diff --git a/docs/en/latest/plugin-develop.md b/docs/en/latest/plugin-develop.md index 09525c396be0..04973c02665e 100644 --- a/docs/en/latest/plugin-develop.md +++ b/docs/en/latest/plugin-develop.md @@ -259,7 +259,7 @@ Here is the consumer configuration for key-auth plugin: } ``` -It will be used when you try to create a [Consumer](https://github.com/apache/apisix/blob/master/docs/en/latest/admin-api.md#consumer) +It will be used when you try to create a [Consumer](./admin-api.md#consumer) To validate the configuration, the plugin uses a schema like this: diff --git a/docs/en/latest/plugins/elasticsearch-logger.md b/docs/en/latest/plugins/elasticsearch-logger.md index 36cc97229dcc..4242a5cc9682 100644 --- a/docs/en/latest/plugins/elasticsearch-logger.md +++ b/docs/en/latest/plugins/elasticsearch-logger.md @@ -195,7 +195,7 @@ You can also set the format of the logs by configuring the Plugin metadata. The | Name | Type | Required | Default | Description | | ---------- | ------ | -------- | ------------------------------------------------------------ | ------------------------------------------------------------ | -| log_format | object | False | {"host": "$host", "@timestamp": "$time_iso8601", "client_ip": "$remote_addr"} | Log format declared as key value pairs in JSON format. Values only support strings. [APISIX](https://github.com/apache/apisix/blob/master/docs/en/latest/apisix-variable.md) or [Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by prefixing the string with `$`. | +| log_format | object | False | {"host": "$host", "@timestamp": "$time_iso8601", "client_ip": "$remote_addr"} | Log format declared as key value pairs in JSON format. Values only support strings. [APISIX](../apisix-variable.md) or [Nginx](http://nginx.org/en/docs/varindex.html) variables can be used by prefixing the string with `$`. | :::info IMPORTANT diff --git a/docs/zh/latest/README.md b/docs/zh/latest/README.md index 7de385278b6b..070f639c36d6 100644 --- a/docs/zh/latest/README.md +++ b/docs/zh/latest/README.md @@ -229,7 +229,7 @@ A/B 测试、金丝雀发布（灰度发布）、蓝绿部署、限流限速、 -欢迎用户把自己加入到 [Powered By](https://github.com/apache/apisix/blob/master/powered-by.md) 页面。 +欢迎用户把自己加入到 [Powered By](../../../powered-by.md) 页面。 ## 全景图 diff --git a/docs/zh/latest/building-apisix.md b/docs/zh/latest/building-apisix.md index b897bf9be9f6..8966eeb7b085 100644 --- a/docs/zh/latest/building-apisix.md +++ b/docs/zh/latest/building-apisix.md @@ -273,4 +273,4 @@ APISIX 的一些特性需要在 OpenResty 中引入额外的 NGINX 模块。 prove -Itest-nginx/lib -r t/plugin/openid-connect.t ``` -如果你想要了解更多信息，请参考 [testing framework](https://github.com/apache/apisix/blob/master/docs/en/latest/internal/testing-framework.md)。 +如果你想要了解更多信息，请参考 [testing framework](../../en/latest/internal/testing-framework.md)。 diff --git a/docs/zh/latest/discovery/kubernetes.md b/docs/zh/latest/discovery/kubernetes.md index 11e44991a199..0c390b785fce 100644 --- a/docs/zh/latest/discovery/kubernetes.md +++ b/docs/zh/latest/discovery/kubernetes.md @@ -32,7 +32,7 @@ description: 本文将介绍如何在 Apache APISIX 中基于 Kubernetes 进行 Kubernetes 服务发现以 [_List-Watch_](https://kubernetes.io/docs/reference/using-api/api-concepts) 方式监听 [_Kubernetes_](https://kubernetes.io) 集群 [_Endpoints_](https://kubernetes.io/docs/concepts/services-networking/service) 资源的实时变化，并将其值存储到 ngx.shared.DICT 中。 -同时遵循 [_APISIX Discovery 规范_](https://github.com/apache/apisix/blob/master/docs/zh/latest/discovery.md) 提供了节点查询接口。 +同时遵循 [_APISIX Discovery 规范_](../discovery.md) 提供了节点查询接口。 :::note @@ -122,7 +122,7 @@ discovery: ### 单集群模式 Kubernetes 服务发现的查询接口 -单集群模式 Kubernetes 服务发现遵循 [_APISIX Discovery 规范_](https://github.com/apache/apisix/blob/master/docs/zh/latest/discovery.md) 提供节点查询接口。 +单集群模式 Kubernetes 服务发现遵循 [_APISIX Discovery 规范_](../discovery.md) 提供节点查询接口。 **函数：** nodes(service_name) @@ -231,7 +231,7 @@ discovery: ### 多集群模式 Kubernetes 服务发现的查询接口 -多集群模式 Kubernetes 服务发现遵循 [_APISIX Discovery 规范_](https://github.com/apache/apisix/blob/master/docs/zh/latest/discovery.md) 提供节点查询接口。 +多集群模式 Kubernetes 服务发现遵循 [_APISIX Discovery 规范_](../discovery.md) 提供节点查询接口。 **函数：** nodes(service_name) diff --git a/docs/zh/latest/plugin-develop.md b/docs/zh/latest/plugin-develop.md index 01327903bdb8..383a05d4d55d 100644 --- a/docs/zh/latest/plugin-develop.md +++ b/docs/zh/latest/plugin-develop.md @@ -239,7 +239,7 @@ local _M = { } ``` -你在创建 [Consumer](https://github.com/apache/apisix/blob/master/docs/zh/latest/admin-api.md#consumer) 时会用到它。 +你在创建 [Consumer](./admin-api.md#consumer) 时会用到它。 为了检验这个配置，这个插件使用了如下的 schema: diff --git a/docs/zh/latest/plugins/elasticsearch-logger.md b/docs/zh/latest/plugins/elasticsearch-logger.md index a65ec77059af..2ec05d0a765c 100644 --- a/docs/zh/latest/plugins/elasticsearch-logger.md +++ b/docs/zh/latest/plugins/elasticsearch-logger.md @@ -192,7 +192,7 @@ curl -X GET "http://127.0.0.1:9200/services/_search" | jq . | 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 | | ---------- | ------ | ------ | ------------------------------------------------------------ | ------ | ------------------------------------------------------------ | -| log_format | object | 可选 | {"host": "$host", "@timestamp": "$time_iso8601", "client_ip": "$remote_addr"} | | 以 JSON 格式的键值对来声明日志格式。对于值部分，仅支持字符串。如果是以 `$` 开头，则表明是要获取 [APISIX 变量](https://github.com/apache/apisix/blob/master/docs/en/latest/apisix-variable.md) 或 [Nginx 内置变量](http://nginx.org/en/docs/varindex.html)。请注意，**该设置是全局生效的**，因此在指定 log_format 后，将对所有绑定 elasticsearch-logger 的 Route 或 Service 生效。 | +| log_format | object | 可选 | {"host": "$host", "@timestamp": "$time_iso8601", "client_ip": "$remote_addr"} | | 以 JSON 格式的键值对来声明日志格式。对于值部分，仅支持字符串。如果是以 `$` 开头，则表明是要获取 [APISIX 变量](../apisix-variable.md) 或 [Nginx 内置变量](http://nginx.org/en/docs/varindex.html)。请注意，**该设置是全局生效的**，因此在指定 log_format 后，将对所有绑定 elasticsearch-logger 的 Route 或 Service 生效。 | ### 设置日志格式示例