This is an automated email from the ASF dual-hosted git repository.
spacewander pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git
The following commit(s) were added to refs/heads/master by this push:
new 49e4fd3 docs: Improve proxy-rewrite plugin docs (#3929)
49e4fd3 is described below
commit 49e4fd307c65dc125e62987b3634a9e7358179bf
Author: qian0817 <[email protected]>
AuthorDate: Mon Mar 29 15:14:13 2021 +0800
docs: Improve proxy-rewrite plugin docs (#3929)
---
docs/en/latest/getting-started.md | 2 +-
docs/en/latest/plugins/proxy-rewrite.md | 8 ++++----
docs/zh/latest/plugins/proxy-rewrite.md | 8 ++++----
3 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/docs/en/latest/getting-started.md
b/docs/en/latest/getting-started.md
index 6592631..13f685c 100644
--- a/docs/en/latest/getting-started.md
+++ b/docs/en/latest/getting-started.md
@@ -219,7 +219,7 @@ curl -i -X GET http://127.0.0.1:9080/get -H "Host:
httpbin.org" -H 'apikey: supe
## Add a prefix to the route
Now lets say you want to add a prefix (eg: samplePrefix) to the route and do
not want to use the `host` header then you can use
-the proxy rewrite plugin to do it.
+the proxy-rewrite plugin to do it.
```bash
curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY:
edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
diff --git a/docs/en/latest/plugins/proxy-rewrite.md
b/docs/en/latest/plugins/proxy-rewrite.md
index c4afb07..f5adf1f 100644
--- a/docs/en/latest/plugins/proxy-rewrite.md
+++ b/docs/en/latest/plugins/proxy-rewrite.md
@@ -45,7 +45,7 @@ The `proxy-rewrite` is an upstream proxy information
rewriting plugin, which sup
## How To Enable
-Here's an example, enable the `proxy rewrite` plugin on the specified route:
+Here's an example, enable the `proxy-rewrite` plugin on the specified route:
```shell
curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY:
edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
@@ -87,11 +87,11 @@ Send the request and see upstream `access.log', if the
output information is con
127.0.0.1 - [26/Sep/2019:10:52:20 +0800] iresty.com GET /test/home.html
HTTP/1.1 200 38 - curl/7.29.0 - 0.000 199 107
```
-This means that the `proxy rewrite` plugin is in effect.
+This means that the `proxy-rewrite` plugin is in effect.
## Disable Plugin
-When you want to disable the `proxy rewrite` plugin, it is very simple,
+When you want to disable the `proxy-rewrite` plugin, it is very simple,
you can delete the corresponding json configuration in the plugin
configuration,
no need to restart the service, it will take effect immediately :
@@ -110,4 +110,4 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H
'X-API-KEY: edd1c9f034335f1
}'
```
-The `proxy rewrite` plugin has been disabled now. It works for other plugins.
+The `proxy-rewrite` plugin has been disabled now. It works for other plugins.
diff --git a/docs/zh/latest/plugins/proxy-rewrite.md
b/docs/zh/latest/plugins/proxy-rewrite.md
index 6e2d6d1..e544909 100644
--- a/docs/zh/latest/plugins/proxy-rewrite.md
+++ b/docs/zh/latest/plugins/proxy-rewrite.md
@@ -45,7 +45,7 @@ proxy-rewrite 是上游代理信息重写插件,支持对 `scheme`、`uri`、`
## 如何启用
-下面是一个示例,在指定的 route 上开启了 `proxy rewrite` 插件:
+下面是一个示例,在指定的 route 上开启了 `proxy-rewrite` 插件:
```shell
curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY:
edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
@@ -87,11 +87,11 @@ curl -X GET http://127.0.0.1:9080/test/index.html
127.0.0.1 - [26/Sep/2019:10:52:20 +0800] iresty.com GET /test/home.html
HTTP/1.1 200 38 - curl/7.29.0 - 0.000 199 107
```
-即表示 `proxy rewrite` 插件生效了。
+即表示 `proxy-rewrite` 插件生效了。
## 禁用插件
-当你想去掉 `proxy rewrite` 插件的时候,很简单,在插件的配置中把对应的 json 配置删除即可,无须重启服务,即刻生效:
+当你想去掉 `proxy-rewrite` 插件的时候,很简单,在插件的配置中把对应的 json 配置删除即可,无须重启服务,即刻生效:
```shell
curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY:
edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
@@ -108,4 +108,4 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H
'X-API-KEY: edd1c9f034335f1
}'
```
-现在就已经移除了 `proxy rewrite` 插件了。其他插件的开启和移除也是同样的方法。
+现在就已经移除了 `proxy-rewrite` 插件了。其他插件的开启和移除也是同样的方法。