[incubator-inlong-website] branch master updated: [INLONG-1403][DataProxy] fix some error in dataproxy-sdk readme (#119)

[go...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

gosonzhang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-inlong-website.git


The following commit(s) were added to refs/heads/master by this push:
     new b204053  [INLONG-1403][DataProxy] fix some error in dataproxy-sdk readme (#119)
b204053 is described below

commit b204053a719ba41e25ff68df7600039516cfff7a
Author: ziruipeng <zp...@connect.ust.hk>
AuthorDate: Thu Jul 29 11:25:20 2021 +0800

    [INLONG-1403][DataProxy] fix some error in dataproxy-sdk readme (#119)
    
    Co-authored-by: stingpeng <st...@tencent.com>
---
 docs/en-us/modules/dataproxy-sdk/quick_start.md  |  6 +++---
 docs/zh-cn/modules/dataproxy-sdk/architecture.md | 14 +++++++-------
 docs/zh-cn/modules/dataproxy-sdk/quick_start.md  |  6 +++---
 3 files changed, 13 insertions(+), 13 deletions(-)

diff --git a/docs/en-us/modules/dataproxy-sdk/quick_start.md b/docs/en-us/modules/dataproxy-sdk/quick_start.md
index a96047a..948abb1 100644
--- a/docs/en-us/modules/dataproxy-sdk/quick_start.md
+++ b/docs/en-us/modules/dataproxy-sdk/quick_start.md
@@ -3,7 +3,7 @@
 add dependency in pom and use the api in architecture.md
 
     <dependency>
-    <groupId>com.tencent.tdbank</groupId>
-    <artifactId>TDBusSDK</artifactId>
-    <version>1.2.21</version>
+            <groupId>org.apache.inlong</groupId>
+            <artifactId>inlong-dataproxy-sdk</artifactId>
+            <version>0.10.0-incubating-SNAPSHOT</version>
     </dependency>
\ No newline at end of file
diff --git a/docs/zh-cn/modules/dataproxy-sdk/architecture.md b/docs/zh-cn/modules/dataproxy-sdk/architecture.md
index e4920b8..59a1663 100644
--- a/docs/zh-cn/modules/dataproxy-sdk/architecture.md
+++ b/docs/zh-cn/modules/dataproxy-sdk/architecture.md
@@ -1,10 +1,10 @@
 # 一、说明
 
-在业务使用消息接入方式时，业务一般仅需将数据按照proxy可识别的格式（如六段协议、数字化协议等）
+在业务使用消息接入方式时，业务一般仅需将数据按照DataProxy可识别的格式（如六段协议、数字化协议等）
 进行组包发送，就可以将数据接入到inlong。但为了保证数据可靠性、负载均衡、动态更新proxy列表等安全特性
 用户程序就需要考虑更多最终导致程序过于繁琐臃肿。
 
-API的设计初衷就是为了简化用户接入，承担部分可靠性相关的逻辑。用户通过在服务送程序中集成API后，即可将数据发送到proxy，而不用关心组包格式、负载均衡等逻辑。
+API的设计初衷就是为了简化用户接入，承担部分可靠性相关的逻辑。用户通过在服务送程序中集成API后，即可将数据发送到DataProxy，而不用关心组包格式、负载均衡等逻辑。
 
 # 二、功能说明
 
@@ -12,12 +12,12 @@ API的设计初衷就是为了简化用户接入，承担部分可靠性相关
 
 |  功能   | 详细描述  |
 |  ----  | ----  |
-| 组包功能（新）  | 将用户数据按proxy可识别的组包格式（如六段协议、数字化协议等）打包发送到TDBus|
-| 压缩功能  | 发送proxy前，将用户数据进行压缩，减少网络带宽占用 |
-| 维护TDBus列表  | 每隔五分钟获取proxy列表 ，以检测运维侧是否存在上下线proxy机器的情况；每隔20s自动剔除不可用连接，以保证已连接的proxy能正常运作 |
+| 组包功能（新）  | 将用户数据按打包发送到DataProxy可识别的组包格式（如六段协议、数字化协议等）打包发送到DataProxy|
+| 压缩功能  | 发送打包发送到DataProxy前，将用户数据进行压缩，减少网络带宽占用 |
+| 维护DataProxy列表  | 每隔五分钟获取打包发送到DataProxy列表 ，以检测运维侧是否存在上下线DataProxy机器的情况；每隔20s自动剔除不可用连接，以保证已连接的DataProxy能正常运作 |
 | 指标统计（新）  | 增加业务分钟级别发送量的指标（接口级） |
-| 负载均衡（新）  | 使用新的策略将发送的数据在多个proxy间进行负载均衡，不再依靠简单的随机+轮询机制来保证 |
-| proxy列表持久化（新）  | 根据业务id对proxy列表持久化，防止程序启动时配置中心发生故障无法发送数据
+| 负载均衡（新）  | 使用新的策略将发送的数据在多个DataProxy间进行负载均衡，不再依靠简单的随机+轮询机制来保证 |
+| DataProxy列表持久化（新）  | 根据业务id对DataProxy列表持久化，防止程序启动时配置中心发生故障无法发送数据
 
 
 ## 2.2 数据发送功能说明
diff --git a/docs/zh-cn/modules/dataproxy-sdk/quick_start.md b/docs/zh-cn/modules/dataproxy-sdk/quick_start.md
index 8893a21..503e0c8 100644
--- a/docs/zh-cn/modules/dataproxy-sdk/quick_start.md
+++ b/docs/zh-cn/modules/dataproxy-sdk/quick_start.md
@@ -3,7 +3,7 @@
 编写java程序时，增加pom配置如下：
 
     <dependency>
-    <groupId>com.tencent.tdbank</groupId>
-    <artifactId>TDBusSDK</artifactId>
-    <version>1.2.21</version>
+            <groupId>org.apache.inlong</groupId>
+            <artifactId>inlong-dataproxy-sdk</artifactId>
+            <version>0.10.0-incubating-SNAPSHOT</version>
     </dependency>
\ No newline at end of file