Skip to content

Commit

Permalink
github(both): improve README.md and simplify PR templates (#5430)
Browse files Browse the repository at this point in the history
ref #3194
  • Loading branch information
Rustin170506 authored May 16, 2022
1 parent 5ae7c41 commit 46136be
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 27 deletions.
26 changes: 6 additions & 20 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<!--
Thank you for contributing to TiDB-CDC! Please read MD's [CONTRIBUTING](https://github.com/pingcap/tidb-cdc/blob/master/CONTRIBUTING.md) document **BEFORE** filing this PR.
Thank you for contributing to TiFlow!
Please read MD's [CONTRIBUTING](https://github.com/pingcap/tiflow/blob/master/CONTRIBUTING.md) document **BEFORE** filing this PR.
-->

### What problem does this PR solve?
Expand All @@ -19,37 +20,22 @@ Issue Number: close #xxx

### Check List <!--REMOVE the items that are not applicable-->

Tests <!-- At least one of them must be included. -->
#### Tests <!-- At least one of them must be included. -->

- Unit test
- Integration test
- Manual test (add detailed scripts or steps below)
- No code

Code changes
#### Questions <!-- Authors should answer these questions and reviewers should consider these questions. -->

- Has exported function/method change
- Has exported variable/fields change
- Has interface methods change
- Has persistent data change
##### Will it cause performance regression 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 <!-- bugfixes or new feature need a 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`.
Expand Down
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,15 @@

## 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 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

Expand Down
15 changes: 9 additions & 6 deletions README_TiCDC.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -23,21 +25,22 @@ 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.
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).
Expand Down

0 comments on commit 46136be

Please sign in to comment.