[Doc] Update wechat group QR code and some minor doc improvements (#55)

bytedance · Oct 27, 2022 · 341bd78 · 341bd78
1 parent e78acab
commit 341bd78
Show file tree

Hide file tree

Showing 15 changed files with 31 additions and 14 deletions.
diff --git a/.github/workflows/cicd.yml b/.github/workflows/cicd.yml
@@ -1,4 +1,4 @@
-name: CI
+name: CICD
 
 # Controls when the workflow will run
 on:

diff --git a/README.md b/README.md
@@ -1,10 +1,14 @@
 # BitSail
-[Chinese Version](README_zh.md)
+English | [简体中文](README_zh.md)
+
+[![Build](https://github.com/bytedance/bitsail/actions/workflows/cicd.yml/badge.svg)](https://github.com/bytedance/bitsail/actions/workflows/cicd.yml)
+[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
+[![Join Slack](https://img.shields.io/badge/slack-%23BitSail-72eff8?logo=slack&color=5DADE2&label=Join%20Slack)](https://join.slack.com/t/slack-ted3816/shared_invite/zt-1inff2sip-u7Ej_o73sUgdpJAvqwlEwQ)
 
 ## Introduction
 BitSail is ByteDance's open source data integration engine which is based on distributed architecture and provides high performance. It supports data synchronization between multiple heterogeneous data sources, and provides global data integration solutions in batch, streaming, and incremental scenarios. At present, it serves almost all business lines in ByteDance, such as Douyin, Toutiao, etc., and synchronizes hundreds of trillions data every day.
 
-## Why do we use BitSail
+## Why Do We Use BitSail
 BitSail has been widely used and supports hundreds of trillions of large traffic. At the same time, it has been verified in various scenarios such as the cloud native environment of the volcano engine and the on-premises private cloud environment.
 
 We have accumulated a lot of experience and made a number of optimizations to improve the function of data integration
@@ -20,7 +24,7 @@ We have accumulated a lot of experience and made a number of optimizations to im
 
 - Task running status monitoring, such as traffic, QPS, dirty data, latency, etc.
 
-## BitSail use scenarios
+## BitSail Use Scenarios
 - Mass data synchronization in heterogeneous data sources
 
 - Streaming and batch integration data processing capability
@@ -177,8 +181,7 @@ Start a conversation: Email to this address `bitsail@googlegroups.com`
 Unsubscribe: Email to this address `bitsail+unsubscribe@googlegroups.com`
 
 ### WeChat Group
-If you have WeChat account, please scan this QR code to connect with the BitSail community assistant
-and join the WeChat group chat.
+Welcome to scan this QR code and to join the WeChat group chat.
 
 <img src="docs/images/wechat_QR.png" alt="qr" width="100"/>
 
@@ -189,7 +192,7 @@ Link to [Environment Setup](docs/env_setup.md).
 Link to [Deployment Guide](docs/deployment.md).
 
 ## BitSail Configuration
-Link to [configuration guide](docs/config.md).
+Link to [Configuration Guide](docs/config.md).
 
 ## Contributing Guide
 Link to [Contributing Guide](docs/contributing.md).

diff --git a/README_zh.md b/README_zh.md
@@ -1,5 +1,11 @@
 # BitSail
 
+[English](README.md) | 简体中文
+
+[![Build](https://github.com/bytedance/bitsail/actions/workflows/cicd.yml/badge.svg)](https://github.com/bytedance/bitsail/actions/workflows/cicd.yml)
+[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
+[![加入Slack](https://img.shields.io/badge/slack-%23BitSail-72eff8?logo=slack&color=5DADE2&label=加入%20Slack)](https://join.slack.com/t/slack-ted3816/shared_invite/zt-1inff2sip-u7Ej_o73sUgdpJAvqwlEwQ)
+
 ## 介绍
 BitSail是字节跳动开源的基于分布式架构的高性能数据集成引擎, 支持多种异构数据源间的数据同步，并提供离线、实时、全量、增量场景下的全域数据集成解决方案，目前服务于字节内部几乎所有业务线，包括抖音、今日头条等，每天同步数百万亿数据
 
@@ -158,7 +164,7 @@ BitSail目前已被广泛使用,并支持数百万亿的大流量场景。同时
 取消订阅: 发送Email到此地址 `bitsail+unsubscribe@googlegroups.com`
 
 ### 微信群
-欢迎添加小助手好友加入BitSail微信群参与社区讨论与贡献
+欢迎加入BitSail微信群参与社区讨论与贡献
 
 <img src="docs/images/wechat_QR.png" alt="qr" width="100"/>
 

diff --git a/...tor-jdbc/src/main/java/com/bytedance/bitsail/connector/legacy/jdbc/model/ClusterInfo.java b/...tor-jdbc/src/main/java/com/bytedance/bitsail/connector/legacy/jdbc/model/ClusterInfo.java
@@ -40,7 +40,7 @@ public class ClusterInfo {
 
   private ConnectionInfo master;
 
-  @Singular("slaves")
+  @Singular("slave")
   private List<ConnectionInfo> slaves;
 
   @JSONField(name = "table_names")

diff --git a/.../src/test/java/com/bytedance/bitsail/connector/legacy/jdbc/source/OracleSourceITCase.java b/.../src/test/java/com/bytedance/bitsail/connector/legacy/jdbc/source/OracleSourceITCase.java
@@ -77,7 +77,7 @@ public void testInsertModeOracle() throws Exception {
             .url(container.getJdbcUrl())
             .build();
     ClusterInfo clusterInfo = ClusterInfo.builder()
-            .slaves(connectionInfo)
+            .slave(connectionInfo)
             .build();
     globalConfiguration.set(JdbcReaderOptions.CONNECTIONS, Lists.newArrayList(clusterInfo));
     EmbeddedFlinkCluster.submitJob(globalConfiguration);

diff --git a/docs/config.md b/docs/config.md
@@ -1,5 +1,5 @@
 # Job Configuration Description
-[Chinese Version](config_zh.md)
+English | [简体中文](config_zh.md)
 
 ***BitSail*** script configuration is managed by JSON structure, follow scripts show the complete structure:
 

diff --git a/docs/config_zh.md b/docs/config_zh.md
@@ -1,5 +1,7 @@
 # 任务配置说明
 
+[English](config.md) | 简体中文
+
 ***BitSail*** 完整配置脚本是由一个 JSON 组成的，完整示意结构如下所示：
 
 ``` json

diff --git a/docs/contributing.md b/docs/contributing.md
@@ -1,5 +1,5 @@
 # Contributor Guide
-[Chinese Version](contributing_zh.md)
+English | [简体中文](contributing_zh.md)
 
 BitSail community welcomes contributions from anyone!
 

diff --git a/docs/contributing_zh.md b/docs/contributing_zh.md
@@ -1,5 +1,7 @@
 # 贡献者指引
 
+[English](contributing.md) | 简体中文
+
 BitSail社区欢迎大家的贡献！
 
 ## 如何参与

diff --git a/docs/deployment.md b/docs/deployment.md
@@ -1,5 +1,5 @@
 # Deployment Guide
-[Chinese Version](deployment_zh.md)
+English | [简体中文](deployment_zh.md)
 
 > At present, ***BitSail*** only supports flink deployment on Yarn.<br>
 Other platforms like `native kubernetes` will be release recently.

diff --git a/docs/deployment_zh.md b/docs/deployment_zh.md
@@ -1,5 +1,7 @@
 # 部署指南
 
+[English](deployment.md) | 简体中文
+
 > 目前 BitSail 仅支持在Yarn上部署。
 > 其他平台上的部署（例如原生kubernetes）将在不久后支持。
 

diff --git a/docs/env_setup.md b/docs/env_setup.md
@@ -1,5 +1,5 @@
 # Environment Setup
-[Chinese Version](env_setup_zh.md)
+English | [简体中文](env_setup_zh.md)
 
 -----
 

diff --git a/docs/env_setup_zh.md b/docs/env_setup_zh.md
@@ -1,5 +1,7 @@
 # 环境配置
 
+[English](env_setup.md) | 简体中文
+
 -----
 
 ## 前置条件

diff --git a/docs/images/bitsail_arch.png b/docs/images/bitsail_arch.png
diff --git a/docs/images/wechat_QR.png b/docs/images/wechat_QR.png