You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by sp...@apache.org on 2021/09/01 03:22:43 UTC
[apisix] branch master updated: docs: update web interface to
latest (#4935)
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 b7c1b5e docs: update web interface to latest (#4935)
b7c1b5e is described below
commit b7c1b5e8ce91323b14f80db8bdb4b63ca37bd6ef
Author: okaybase <75...@users.noreply.github.com>
AuthorDate: Wed Sep 1 11:22:33 2021 +0800
docs: update web interface to latest (#4935)
---
docs/assets/images/plugin/basic-auth-2.png | Bin 88754 -> 5932 bytes
docs/assets/images/plugin/limit-conn-1.png | Bin 72052 -> 13027 bytes
docs/assets/images/plugin/limit-conn-2.png | Bin 325773 -> 0 bytes
docs/assets/images/plugin/limit-count-1.png | Bin 74547 -> 13354 bytes
docs/assets/images/plugin/limit-count-2.png | Bin 119480 -> 0 bytes
docs/assets/images/plugin/limit-req-1.png | Bin 70315 -> 11571 bytes
docs/assets/images/plugin/limit-req-2.png | Bin 289197 -> 0 bytes
docs/assets/images/plugin/skywalking-1.png | Bin 22230 -> 4948 bytes
docs/assets/images/plugin/skywalking-2.png | Bin 30629 -> 0 bytes
docs/assets/images/plugin/zipkin-1.png | Bin 77813 -> 7647 bytes
docs/assets/images/plugin/zipkin-2.png | Bin 277580 -> 0 bytes
docs/en/latest/plugins/basic-auth.md | 2 +-
docs/en/latest/plugins/key-auth.md | 2 +-
docs/en/latest/plugins/limit-conn.md | 5 +----
docs/en/latest/plugins/limit-count.md | 7 ++-----
docs/en/latest/plugins/limit-req.md | 9 ++-------
docs/en/latest/plugins/skywalking.md | 7 +++----
docs/en/latest/plugins/wolf-rbac.md | 2 +-
docs/en/latest/plugins/zipkin.md | 6 +-----
docs/zh/latest/plugins/basic-auth.md | 2 +-
docs/zh/latest/plugins/key-auth.md | 2 +-
docs/zh/latest/plugins/limit-conn.md | 5 +----
docs/zh/latest/plugins/limit-count.md | 7 ++-----
docs/zh/latest/plugins/limit-req.md | 8 ++------
docs/zh/latest/plugins/skywalking.md | 6 +-----
docs/zh/latest/plugins/wolf-rbac.md | 2 +-
docs/zh/latest/plugins/zipkin.md | 6 +-----
27 files changed, 22 insertions(+), 56 deletions(-)
diff --git a/docs/assets/images/plugin/basic-auth-2.png b/docs/assets/images/plugin/basic-auth-2.png
index c269db7..70fa618 100644
Binary files a/docs/assets/images/plugin/basic-auth-2.png and b/docs/assets/images/plugin/basic-auth-2.png differ
diff --git a/docs/assets/images/plugin/limit-conn-1.png b/docs/assets/images/plugin/limit-conn-1.png
index 3e46a6b..037e386 100644
Binary files a/docs/assets/images/plugin/limit-conn-1.png and b/docs/assets/images/plugin/limit-conn-1.png differ
diff --git a/docs/assets/images/plugin/limit-conn-2.png b/docs/assets/images/plugin/limit-conn-2.png
deleted file mode 100644
index dfbb0f1..0000000
Binary files a/docs/assets/images/plugin/limit-conn-2.png and /dev/null differ
diff --git a/docs/assets/images/plugin/limit-count-1.png b/docs/assets/images/plugin/limit-count-1.png
index 9b9b28e..8fc1ef6 100644
Binary files a/docs/assets/images/plugin/limit-count-1.png and b/docs/assets/images/plugin/limit-count-1.png differ
diff --git a/docs/assets/images/plugin/limit-count-2.png b/docs/assets/images/plugin/limit-count-2.png
deleted file mode 100644
index 64f99cb..0000000
Binary files a/docs/assets/images/plugin/limit-count-2.png and /dev/null differ
diff --git a/docs/assets/images/plugin/limit-req-1.png b/docs/assets/images/plugin/limit-req-1.png
index 4512837..8f8e1f9 100644
Binary files a/docs/assets/images/plugin/limit-req-1.png and b/docs/assets/images/plugin/limit-req-1.png differ
diff --git a/docs/assets/images/plugin/limit-req-2.png b/docs/assets/images/plugin/limit-req-2.png
deleted file mode 100644
index 0e4726d..0000000
Binary files a/docs/assets/images/plugin/limit-req-2.png and /dev/null differ
diff --git a/docs/assets/images/plugin/skywalking-1.png b/docs/assets/images/plugin/skywalking-1.png
index 9560c19..d80879c 100644
Binary files a/docs/assets/images/plugin/skywalking-1.png and b/docs/assets/images/plugin/skywalking-1.png differ
diff --git a/docs/assets/images/plugin/skywalking-2.png b/docs/assets/images/plugin/skywalking-2.png
deleted file mode 100644
index f7d9d4c..0000000
Binary files a/docs/assets/images/plugin/skywalking-2.png and /dev/null differ
diff --git a/docs/assets/images/plugin/zipkin-1.png b/docs/assets/images/plugin/zipkin-1.png
index 60698a4..7b3451a 100644
Binary files a/docs/assets/images/plugin/zipkin-1.png and b/docs/assets/images/plugin/zipkin-1.png differ
diff --git a/docs/assets/images/plugin/zipkin-2.png b/docs/assets/images/plugin/zipkin-2.png
deleted file mode 100644
index acfb0b6..0000000
Binary files a/docs/assets/images/plugin/zipkin-2.png and /dev/null differ
diff --git a/docs/en/latest/plugins/basic-auth.md b/docs/en/latest/plugins/basic-auth.md
index 154f4df..e618a58 100644
--- a/docs/en/latest/plugins/basic-auth.md
+++ b/docs/en/latest/plugins/basic-auth.md
@@ -61,7 +61,7 @@ curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f1
}'
```
-you can visit Dashboard `http://127.0.0.1:9080/apisix/dashboard/` and add a Consumer through the web console:
+you also can add a Consumer through the web console:
diff --git a/docs/en/latest/plugins/key-auth.md b/docs/en/latest/plugins/key-auth.md
index c86dabf..aaea706 100644
--- a/docs/en/latest/plugins/key-auth.md
+++ b/docs/en/latest/plugins/key-auth.md
@@ -68,7 +68,7 @@ curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f1
}'
```
-You can open dashboard with a browser: `http://127.0.0.1:9080/apisix/dashboard/`, to complete the above operation through the web interface, first add a route:
+You also can complete the above operation through the web interface, first add a route:
Then add key-auth plugin:
diff --git a/docs/en/latest/plugins/limit-conn.md b/docs/en/latest/plugins/limit-conn.md
index 9c985e8..2a468a6 100644
--- a/docs/en/latest/plugins/limit-conn.md
+++ b/docs/en/latest/plugins/limit-conn.md
@@ -77,12 +77,9 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f13
}'
```
-You can open dashboard with a browser: `http://127.0.0.1:9080/apisix/dashboard/`, to complete the above operation through the web interface, first add a route:
+You also can complete the above operation through the web interface, first add a route, then add limit-conn plugin:
-Then add limit-conn plugin:
-
-
## Test Plugin
The parameters of the plugin enabled above indicate that only one concurrent request is allowed. When more than one concurrent request is received, will return `503` directly.
diff --git a/docs/en/latest/plugins/limit-count.md b/docs/en/latest/plugins/limit-count.md
index 276f77c..2a4302e 100644
--- a/docs/en/latest/plugins/limit-count.md
+++ b/docs/en/latest/plugins/limit-count.md
@@ -80,11 +80,8 @@ curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335
}'
```
-You can open dashboard with a browser: `http://127.0.0.1:9080/apisix/dashboard/`, to complete the above operation through the web interface, first add a route:
-
-
-Then add limit-count plugin:
-
+You also can complete the above operation through the web interface, first add a route, then add limit-count plugin:
+
If you need a cluster-level precision traffic limit, then we can do it with the redis server. The rate limit of the traffic will be shared between different APISIX nodes to limit the rate of cluster traffic.
diff --git a/docs/en/latest/plugins/limit-req.md b/docs/en/latest/plugins/limit-req.md
index 3f34632..1792adb 100644
--- a/docs/en/latest/plugins/limit-req.md
+++ b/docs/en/latest/plugins/limit-req.md
@@ -76,13 +76,8 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f13
}'
```
-You can open dashboard with a browser: `http://127.0.0.1:9080/apisix/dashboard/`, to complete the above operation through the web interface, first add a route:
-
-
-
-Then add limit-req plugin:
-
-
+You also can complete the above operation through the web interface, first add a route, then add limit-req plugin:
+
**Test Plugin**
diff --git a/docs/en/latest/plugins/skywalking.md b/docs/en/latest/plugins/skywalking.md
index 4f718d2..62e99c9 100644
--- a/docs/en/latest/plugins/skywalking.md
+++ b/docs/en/latest/plugins/skywalking.md
@@ -78,10 +78,9 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f1
}'
```
-You can open dashboard with a browser:`http://127.0.0.1:9080/apisix/dashboard/`，to complete the above operation through the web interface, first add a route:\
-\
-Then add skywalking plugin:\
-
+You also can complete the above operation through the web interface, first add a route, then add skywalking plugin:
+
+
## How to set endpoint
diff --git a/docs/en/latest/plugins/wolf-rbac.md b/docs/en/latest/plugins/wolf-rbac.md
index ae68388..8399465 100644
--- a/docs/en/latest/plugins/wolf-rbac.md
+++ b/docs/en/latest/plugins/wolf-rbac.md
@@ -81,7 +81,7 @@ curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f
}'
```
-You can visit the dashboard: `http://127.0.0.1:9080/apisix/dashboard/`, to complete the above operations through the web interface, first add a consumer:
+You also can complete the above operations through the web interface, first add a consumer:
Then add the wolf-rbac plugin to the consumer page:
diff --git a/docs/en/latest/plugins/zipkin.md b/docs/en/latest/plugins/zipkin.md
index 33846be..6a0c1aa 100644
--- a/docs/en/latest/plugins/zipkin.md
+++ b/docs/en/latest/plugins/zipkin.md
@@ -93,14 +93,10 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f1
}'
```
-You can open dashboard with a browser: `http://127.0.0.1:9080/apisix/dashboard/`, to complete the above operation through the web interface, first add a route:
+You also can complete the above operation through the web interface, first add a route, then add zipkin plugin:
-Then add zipkin plugin:
-
-
-
## Test Plugin
### run the Zipkin instance
diff --git a/docs/zh/latest/plugins/basic-auth.md b/docs/zh/latest/plugins/basic-auth.md
index fa57e0d..667721b 100644
--- a/docs/zh/latest/plugins/basic-auth.md
+++ b/docs/zh/latest/plugins/basic-auth.md
@@ -61,7 +61,7 @@ curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f1
}'
```
-你可以使用浏览器打开 dashboard：`http://127.0.0.1:9080/apisix/dashboard/`，通过 web 界面来完成上面的操作，先增加一个 consumer：
+你也可以通过 web 界面来完成上面的操作，先增加一个 consumer：
diff --git a/docs/zh/latest/plugins/key-auth.md b/docs/zh/latest/plugins/key-auth.md
index ac1481c..a36e7fb 100644
--- a/docs/zh/latest/plugins/key-auth.md
+++ b/docs/zh/latest/plugins/key-auth.md
@@ -66,7 +66,7 @@ curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f1
}'
```
-你可以使用浏览器打开 dashboard：`http://127.0.0.1:9080/apisix/dashboard/`，通过 web 界面来完成上面的操作，先增加一个 consumer：
+你也可以通过 web 界面来完成上面的操作，先增加一个 consumer：
然后在 consumer 页面中添加 key-auth 插件：
diff --git a/docs/zh/latest/plugins/limit-conn.md b/docs/zh/latest/plugins/limit-conn.md
index 6607d77..2ff5f73 100644
--- a/docs/zh/latest/plugins/limit-conn.md
+++ b/docs/zh/latest/plugins/limit-conn.md
@@ -68,12 +68,9 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f13
}'
```
-你可以使用浏览器打开 dashboard：`http://127.0.0.1:9080/apisix/dashboard/`，通过 web 界面来完成上面的操作，先增加一个 route：
+你也可以通过 web 界面来完成上面的操作，先增加一个 route，然后在插件页面中添加 limit-conn 插件：
-然后在 route 页面中添加 limit-conn 插件：
-
-
#### test plugin
上面启用的插件的参数表示只允许一个并发请求。 当收到多个并发请求时，将直接返回 503 拒绝请求。
diff --git a/docs/zh/latest/plugins/limit-count.md b/docs/zh/latest/plugins/limit-count.md
index b7f22f6..d8e505c 100644
--- a/docs/zh/latest/plugins/limit-count.md
+++ b/docs/zh/latest/plugins/limit-count.md
@@ -85,11 +85,8 @@ curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335
}'
```
-你可以使用浏览器打开 dashboard：`http://127.0.0.1:9080/apisix/dashboard/`，通过 web 界面来完成上面的操作，先增加一个 route：
-
-
-然后在 route 页面中添加 limit-count 插件：
-
+你也可以通过 web 界面来完成上面的操作，先增加一个 route，然后在插件页面中添加 limit-count 插件：
+
如果你需要一个集群级别的流量控制，我们可以借助 redis server 来完成。不同的 APISIX 节点之间将共享流量限速结果，实现集群流量限速。
diff --git a/docs/zh/latest/plugins/limit-req.md b/docs/zh/latest/plugins/limit-req.md
index fdedfb0..7b57c15 100644
--- a/docs/zh/latest/plugins/limit-req.md
+++ b/docs/zh/latest/plugins/limit-req.md
@@ -76,13 +76,9 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f13
}'
```
-你可以使用浏览器打开 dashboard：`http://127.0.0.1:9080/apisix/dashboard/`，通过 web 界面来完成上面的操作，先增加一个 route：
+你也可以通过 web 界面来完成上面的操作，先增加一个 route，然后在插件页面中添加 limit-req 插件：
-
-
-然后在 route 页面中添加 limit-req 插件：
-
-
+
**测试插件**
diff --git a/docs/zh/latest/plugins/skywalking.md b/docs/zh/latest/plugins/skywalking.md
index 9172d88..edaf65d 100644
--- a/docs/zh/latest/plugins/skywalking.md
+++ b/docs/zh/latest/plugins/skywalking.md
@@ -79,14 +79,10 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f1
}'
```
-你可以使用浏览器打开 dashboard：`http://127.0.0.1:9080/apisix/dashboard/`，通过 web 界面来完成上面的操作，先增加一个 route：
+你也可以通过 web 界面来完成上面的操作，先增加一个 route，然后在插件页面中添加 skywalking 插件：
-然后在 route 页面中添加 skywalking 插件：
-
-
-
## 如何设置 endpoint
我们可以通过指定 `conf/config.yaml` 中的配置来指定 endpoint：
diff --git a/docs/zh/latest/plugins/wolf-rbac.md b/docs/zh/latest/plugins/wolf-rbac.md
index a9c6ee5..ee81c8c 100644
--- a/docs/zh/latest/plugins/wolf-rbac.md
+++ b/docs/zh/latest/plugins/wolf-rbac.md
@@ -81,7 +81,7 @@ curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f
}'
```
-你可以使用浏览器打开 dashboard：`http://127.0.0.1:9080/apisix/dashboard/`，通过 web 界面来完成上面的操作，先增加一个 consumer：
+你也可以通过 web 界面来完成上面的操作，先增加一个 consumer：
然后在 consumer 页面中添加 wolf-rbac 插件：
diff --git a/docs/zh/latest/plugins/zipkin.md b/docs/zh/latest/plugins/zipkin.md
index 626d4e0b6..44a7b91 100644
--- a/docs/zh/latest/plugins/zipkin.md
+++ b/docs/zh/latest/plugins/zipkin.md
@@ -93,14 +93,10 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f1
}'
```
-你可以使用浏览器打开 dashboard：`http://127.0.0.1:9080/apisix/dashboard/`，通过 web 界面来完成上面的操作，先增加一个 route：
+你也可以通过 web 界面来完成上面的操作，先增加一个 route，然后在插件页面中添加 zipkin 插件：
-然后在 route 页面中添加 zipkin 插件：
-
-
-
## 测试插件
### 运行 Zipkin 实例