From 0de6f7e46f5aa682be730c99997170ab4fafa259 Mon Sep 17 00:00:00 2001 From: hi-rustin Date: Mon, 16 May 2022 15:54:11 +0800 Subject: [PATCH 1/6] github(both): improve README.md and simplify PR templates --- .github/pull_request_template.md | 26 ++++++-------------------- README.md | 8 +++++++- 2 files changed, 13 insertions(+), 21 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 313fe239988..c9e5a4dc57d 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,5 +1,6 @@ ### What problem does this PR solve? @@ -19,37 +20,22 @@ Issue Number: close #xxx ### Check List -Tests +#### Tests - Unit test - Integration test - Manual test (add detailed scripts or steps below) - No code -Code changes +#### Questions - - Has exported function/method change - - Has exported variable/fields change - - Has interface methods change - - Has persistent data change +##### Will it cause performance setbacks or break compatibility? -Side effects - - - Possible performance regression - - Increased code complexity - - Breaking backward compatibility - -Related changes - - - Need to cherry-pick to the release branch - - Need to update the documentation - - Need to update key monitor metrics in both TiCDC document and official document +##### Do you need to update user documentation, design documentation or monitoring documentation? ### Release note ```release-note -Please add a release note. - Please refer to [Release Notes Language Style Guide](https://pingcap.github.io/tidb-dev-guide/contribute-to-tidb/release-notes-style-guide.html) to write a quality release note. If you don't think this PR needs a release note then fill it with `None`. diff --git a/README.md b/README.md index 739eece687b..6b543393bef 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,13 @@ ## Introduction -**TiFlow** is a unified data replication platform around [TiDB](https://docs.pingcap.com/tidb/stable), including two main components: DM and TiCDC. DM supports full data migration and incremental data replication from MySQL/MariaDB into [TiDB](https://docs.pingcap.com/tidb/stable). TiCDC supports replicating change data to various downstreams, including MySQL protocol-compatible databases, message queues via the open TiCDC protocol and other systems such as local file storage. More details can be found in [DM README](./README_DM.md) and [TiCDC README](./README_TiCDC.md). +**TiFlow** is a unified data replication platform around [TiDB](https://docs.pingcap.com/tidb/stable), +including two main components: DM and TiCDC. +DM supports full data migration and incremental data replication from MySQL/MariaDB +into [TiDB](https://docs.pingcap.com/tidb/stable). +TiCDC supports replicating change data to various downstreams, including MySQL protocol-compatible databases +and [Kafka](https://kafka.apache.org/). +More details can be found in [DM README](./README_DM.md) and [TiCDC README](./README_TiCDC.md). ## License From 3835382810c37720558443ca13e4f5a63960acde Mon Sep 17 00:00:00 2001 From: hi-rustin Date: Mon, 16 May 2022 16:02:59 +0800 Subject: [PATCH 2/6] github(both): better comment --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index c9e5a4dc57d..6bb21f2731b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -27,7 +27,7 @@ Issue Number: close #xxx - Manual test (add detailed scripts or steps below) - No code -#### Questions +#### Questions ##### Will it cause performance setbacks or break compatibility? From c5a5607ff418efd9f0bd413c8ae0e280fff60224 Mon Sep 17 00:00:00 2001 From: hi-rustin Date: Mon, 16 May 2022 16:04:12 +0800 Subject: [PATCH 3/6] github(both): better word --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 6bb21f2731b..28ca9e81609 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -29,7 +29,7 @@ Issue Number: close #xxx #### Questions -##### Will it cause performance setbacks or break compatibility? +##### Will it cause performance regression or break compatibility? ##### Do you need to update user documentation, design documentation or monitoring documentation? From bfff352b389253e6e06f92edc0e70094c95d7090 Mon Sep 17 00:00:00 2001 From: hi-rustin Date: Mon, 16 May 2022 16:08:00 +0800 Subject: [PATCH 4/6] github(both): improve ticdc docs --- README_TiCDC.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README_TiCDC.md b/README_TiCDC.md index 81fb18d61a3..cbc1028e1c2 100644 --- a/README_TiCDC.md +++ b/README_TiCDC.md @@ -1,6 +1,8 @@ # TiCDC -**TiCDC** is [TiDB](https://docs.pingcap.com/tidb/stable)'s change data capture framework. It supports replicating change data to various downstreams, including MySQL protocol-compatible databases, message queues via the open CDC protocol and other systems such as local file storage. +**TiCDC** is [TiDB](https://docs.pingcap.com/tidb/stable)'s change data capture framework. +It supports replicating change data to various downstreams, including MySQL protocol-compatible databases +and [Kafka](https://kafka.apache.org/). ## Architecture @@ -23,18 +25,18 @@ See a detailed introduction to [the TiCDC architecture](https://docs.pingcap.com To check the source code, run test cases and build binaries, you can simply run: ```bash -$ make +$ make cdc $ make test ``` -Note that TiCDC supports building with Go version `Go >= 1.16`. +Note that TiCDC supports building with Go version `Go >= 1.18`. When TiCDC is built successfully, you can find binary in the `bin` directory. Instructions for unit test and integration test can be found in [Running tests](./tests/integration_tests/README.md). ## Deployment -You can setup a CDC cluster for replication test manually as following: +You can set up a CDC cluster for replication test manually as following: 1. Setup a TiDB cluster. 2. Start a CDC cluster, which contains one or more CDC servers. The command to start on CDC server is `cdc server --pd http://10.0.10.25:2379`, where `http://10.0.10.25:2379` is the client-url of pd-server. From de221f80d7a3421f5a5418a3e0c49aece3eaa1dd Mon Sep 17 00:00:00 2001 From: hi-rustin Date: Mon, 16 May 2022 16:17:14 +0800 Subject: [PATCH 5/6] github(both): address comment --- .github/pull_request_template.md | 2 +- README.md | 12 +++++++----- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 28ca9e81609..a7ba98753d4 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,6 +1,6 @@ ### What problem does this PR solve? diff --git a/README.md b/README.md index 6b543393bef..3aedb922a88 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,13 @@ ## Introduction **TiFlow** is a unified data replication platform around [TiDB](https://docs.pingcap.com/tidb/stable), -including two main components: DM and TiCDC. -DM supports full data migration and incremental data replication from MySQL/MariaDB -into [TiDB](https://docs.pingcap.com/tidb/stable). -TiCDC supports replicating change data to various downstreams, including MySQL protocol-compatible databases -and [Kafka](https://kafka.apache.org/). +including two main components: + +* DM supports full data migration and incremental data replication from MySQL/MariaDB + into [TiDB](https://docs.pingcap.com/tidb/stable). +* TiCDC supports replicating change data to various downstreams, including MySQL protocol-compatible databases + and [Kafka](https://kafka.apache.org/). + More details can be found in [DM README](./README_DM.md) and [TiCDC README](./README_TiCDC.md). ## License From 4b93324a9c70860c7165307133fbe15696c09d45 Mon Sep 17 00:00:00 2001 From: hi-rustin Date: Mon, 16 May 2022 16:19:54 +0800 Subject: [PATCH 6/6] github(both): address comment --- README_TiCDC.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README_TiCDC.md b/README_TiCDC.md index cbc1028e1c2..b73cb1d415f 100644 --- a/README_TiCDC.md +++ b/README_TiCDC.md @@ -38,8 +38,9 @@ test can be found in [Running tests](./tests/integration_tests/README.md). You can set up a CDC cluster for replication test manually as following: -1. Setup a TiDB cluster. -2. Start a CDC cluster, which contains one or more CDC servers. The command to start on CDC server is `cdc server --pd http://10.0.10.25:2379`, where `http://10.0.10.25:2379` is the client-url of pd-server. +1. Set up a TiDB cluster. +2. Start a CDC cluster, which contains one or more CDC servers. The command to start on CDC server + is `cdc server --pd http://10.0.10.25:2379`, where `http://10.0.10.25:2379` is the client-url of pd-server. 3. Start a replication changefeed by `cdc cli changefeed create --pd http://10.0.10.25:2379 --start-ts 413105904441098240 --sink-uri mysql://root:123456@127.0.0.1:3306/`. The TSO is TiDB `timestamp oracle`. If it is not provided or set to zero, the TSO of start time will be used. Currently, we support MySQL protocol-compatible databases as downstream sinks only, and will add more sink types in the future. For details, see [Deploy TiCDC](https://docs.pingcap.com/tidb/stable/deploy-ticdc).