Skip to content

Commit

Permalink
docs: replace some urls that point to github with relative paths (#9684)
Browse files Browse the repository at this point in the history
  • Loading branch information
xuruidong authored Jun 21, 2023
1 parent e19a466 commit d51950d
Show file tree
Hide file tree
Showing 9 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/en/latest/building-apisix.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
6 changes: 3 additions & 3 deletions docs/en/latest/discovery/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/plugin-develop.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/plugins/elasticsearch-logger.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/latest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ A/B 测试、金丝雀发布(灰度发布)、蓝绿部署、限流限速、

<img src="https://user-images.githubusercontent.com/40708551/109484046-f7c4e280-7aa5-11eb-9d71-aab90830773a.png" width="725" height="1700" />

欢迎用户把自己加入到 [Powered By](https://github.com/apache/apisix/blob/master/powered-by.md) 页面。
欢迎用户把自己加入到 [Powered By](../../../powered-by.md) 页面。

## 全景图

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/latest/building-apisix.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)。
6 changes: 3 additions & 3 deletions docs/zh/latest/discovery/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/zh/latest/plugin-develop.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/latest/plugins/elasticsearch-logger.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 生效。 |

### 设置日志格式示例

Expand Down

0 comments on commit d51950d

Please sign in to comment.