You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by we...@apache.org on 2020/05/22 06:43:28 UTC
[incubator-apisix] branch master updated: doc: fix the doc style
for *_logger.md (#1605)
This is an automated email from the ASF dual-hosted git repository.
wenming pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-apisix.git
The following commit(s) were added to refs/heads/master by this push:
new 6fb3ebe doc: fix the doc style for *_logger.md (#1605)
6fb3ebe is described below
commit 6fb3ebef5787822390f1a93a7f6a2d546e717955
Author: dabue <53...@users.noreply.github.com>
AuthorDate: Fri May 22 14:43:20 2020 +0800
doc: fix the doc style for *_logger.md (#1605)
---
doc/plugins/tcp-logger-cn.md | 4 +---
doc/plugins/tcp-logger.md | 3 +--
doc/plugins/udp-logger-cn.md | 4 +---
doc/plugins/udp-logger.md | 2 +-
4 files changed, 4 insertions(+), 9 deletions(-)
diff --git a/doc/plugins/tcp-logger-cn.md b/doc/plugins/tcp-logger-cn.md
index ee260e6..e5fa7c4 100644
--- a/doc/plugins/tcp-logger-cn.md
+++ b/doc/plugins/tcp-logger-cn.md
@@ -18,13 +18,13 @@
-->
# 摘要
+
- [**定义**](#name)
- [**属性列表**](#attributes)
- [**如何开启**](#how-to-enable)
- [**测试插件**](#test-plugin)
- [**禁用插件**](#disable-plugin)
-
## 定义
`tcp-logger` 是用于将日志数据发送到TCP服务的插件。
@@ -46,7 +46,6 @@
| tls |可选的|布尔值，用于控制是否执行SSL验证。|
| tls_options |可选的|TLS 选项|
-
## 如何开启
1. 下面例子展示了如何为指定路由开启 `tcp-logger` 插件的。
@@ -84,7 +83,6 @@ hello, world
## 禁用插件
-
想要禁用“tcp-logger”插件，是非常简单的，将对应的插件配置从json配置删除，就会立即生效，不需要重新启动服务：
```shell
diff --git a/doc/plugins/tcp-logger.md b/doc/plugins/tcp-logger.md
index 435834b..9fd4730 100644
--- a/doc/plugins/tcp-logger.md
+++ b/doc/plugins/tcp-logger.md
@@ -18,13 +18,13 @@
-->
# Summary
+
- [**Name**](#name)
- [**Attributes**](#attributes)
- [**How To Enable**](#how-to-enable)
- [**Test Plugin**](#test-plugin)
- [**Disable Plugin**](#disable-plugin)
-
## Name
`tcp-logger` is a plugin which push Log data requests to TCP servers.
@@ -52,7 +52,6 @@ For more info on Batch-Processor in Apache APISIX please refer.
|max_retry_count|optional |Maximum number of retries before removing from the processing pipe line; default is zero|
|retry_delay |optional |Number of seconds the process execution should be delayed if the execution fails; default is 1|
-
## How To Enable
The following is an example on how to enable the tcp-logger for a specific route.
diff --git a/doc/plugins/udp-logger-cn.md b/doc/plugins/udp-logger-cn.md
index 67dde5a..bad70dd 100644
--- a/doc/plugins/udp-logger-cn.md
+++ b/doc/plugins/udp-logger-cn.md
@@ -18,13 +18,13 @@
-->
# 摘要
+
- [**定义**](#name)
- [**属性列表**](#attributes)
- [**如何开启**](#how-to-enable)
- [**测试插件**](#test-plugin)
- [**禁用插件**](#disable-plugin)
-
## 定义
`udp-logger` 是用于将日志数据发送到UDP服务的插件。
@@ -44,7 +44,6 @@
| port |必要的| 目标端口。|
| timeout |可选的|发送数据超时间。|
-
## 如何开启
1. 下面例子展示了如何为指定路由开启 `udp-logger` 插件的。
@@ -82,7 +81,6 @@ hello, world
## 禁用插件
-
想要禁用“udp-logger”插件，是非常简单的，将对应的插件配置从json配置删除，就会立即生效，不需要重新启动服务：
```shell
diff --git a/doc/plugins/udp-logger.md b/doc/plugins/udp-logger.md
index 8c0b069..ad16550 100644
--- a/doc/plugins/udp-logger.md
+++ b/doc/plugins/udp-logger.md
@@ -18,13 +18,13 @@
-->
# Summary
+
- [**Name**](#name)
- [**Attributes**](#attributes)
- [**How To Enable**](#how-to-enable)
- [**Test Plugin**](#test-plugin)
- [**Disable Plugin**](#disable-plugin)
-
## Name
`udp-logger` is a plugin which push Log data requests to UDP servers.