Skip to content

ticdc, dm: fix wrong values, a parameter name, and identifiers in TiCDC and DM docs (#24488) - #24700

Open
ti-chi-bot wants to merge 3 commits into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-24488-to-release-8.5
Open

ti-chi-bot wants to merge 3 commits into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-24488-to-release-8.5

Conversation

@ti-chi-bot

@ti-chi-bot ti-chi-bot commented Nov 16, 2026 •

Copy link
Copy Markdown
Member

This is an automated cherry-pick of #24488

What is changed, added, or deleted? (Required)

Fix wrong values, a parameter name, and identifiers in the TiCDC and DM docs. These errors were found while reviewing the English docs for issues that affect the Japanese translation. Each fix is shown below; the same wrong text was also searched for in the rest of the docs.

File Before After
ticdc/ticdc-sink-to-kafka.md "Tables in the test1 table" (the matcher is test1.*) "Tables in the test1 database"
ticdc/ticdc-sink-to-kafka.md "add the -enable-tls=true parameter to --sink-uri" enable-tls=true (the sink URI parameter table says enable-tls)
ticdc/ticdc-open-api.md "Query the replication task list" returns "the basic information of all nodes" "of all replication tasks"
ticdc/ticdc-csv.md TIME: "Format: yyyy-MM-dd" (the example is "23:59:59") HH:mm:ss
dm/dm-table-routing.md c-table, c-source c_table, c_source (as in the DDL)
dm/deploy-a-dm-cluster-using-tiup.md "when you deploy TiDB using TiUP" "when you deploy a DM cluster using TiUP"
dm/dm-export-import-config.md "## import the data source …" "## Import …" (as the Export heading)

The "Start downstream TiDB" commands in dm/quick-start-create-task.md also do not work, but fixing them needs a decision on the intended setup, so it is reported separately.

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)

What is the related PR or file link(s)?

  • Related code change PR links (if applicable):
  • This PR is translated from:
  • Other reference link(s):

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Clarified TiUP deployment guidance for DM clusters and corrected capitalization in an import heading.
    • Corrected table and column names in table-routing and migration examples.
    • Updated the documented CSV format for TIME values to HH:mm:ss.
    • Clarified that the replication task list endpoint returns task information based on selected states.
    • Corrected Kafka sink TLS and partition-dispatcher examples.

yahonda and others added 3 commits November 16, 2026 10:13
…d DM docs

- ticdc-sink-to-kafka.md: "Tables in the `test1` table" → database (the
  matcher is `test1.*`), and the sink URI parameter is `enable-tls=true`,
  not `-enable-tls=true`.
- ticdc-open-api.md: the replication task list API returns replication
  tasks, not nodes.
- ticdc-csv.md: the `TIME` format is `HH:mm:ss` (the example is
  "23:59:59").
- dm-table-routing.md: use `c_table` and `c_source`, as the DDL does.
- deploy-a-dm-cluster-using-tiup.md: the note is about deploying a DM
  cluster, not TiDB.
- dm-export-import-config.md: capitalize the "Import" heading, as the
  "Export" heading is.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Without the `state` parameter, the API returns only the tasks in the
normal, stopped, or failed state, so "all replication tasks" is not
accurate.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ti-chi-bot ti-chi-bot added lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR. labels Nov 16, 2026
@ti-chi-bot

ti-chi-bot Bot commented Nov 16, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign kissmydb for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@coderabbitai

coderabbitai Bot commented Nov 16, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

This pull request updates DM and TiCDC documentation. The edits correct terminology, column names, a TIME format, an API description, and Kafka sink examples.

Changes: DM documentation

Layer / File(s) Summary
Deployment and import wording
dm/deploy-a-dm-cluster-using-tiup.md, dm/dm-export-import-config.md
The deployment note refers to deploying a DM cluster. The import section heading now capitalizes “Import.”
Column-name examples
dm/dm-table-routing.md, dm/task-configuration-file-full.md, migrate-small-mysql-shards-to-tidb.md
Table-routing examples and extract-table comments use c_table and c_source instead of hyphenated names.

TiCDC documentation

Layer / File(s) Summary
Data format and API descriptions
ticdc/ticdc-csv.md, ticdc/ticdc-open-api.md
The TIME format is documented as HH:mm:ss. The changefeeds endpoint description refers to replication tasks in selected states.
Kafka sink examples
ticdc/ticdc-sink-to-kafka.md
The TLS URI example uses enable-tls=true. The dispatcher example identifies test1 as a database.

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Other

Possibly related PRs

  • pingcap/docs#24488: This PR cherry-picks the same documentation edits to the release-8.5 branch.

Suggested reviewers: qiancai, kennytm

Merge Risk: Minimal · up to 7376f

This change corrects several documentation errors in the DM and TiCDC docs and does not affect runtime behavior. It is safe to merge.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title names the two areas changed (TiCDC and DM docs) and the kinds of fixes (wrong values, a parameter name, identifiers). It is specific enough to match the changeset, which fixes values, a para…
Description check Passed The description follows the repository template. It includes the required 'What is changed' section with a clear before/after table for each fix, the version applicability checkboxes (master and v8.5 …
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title names the two areas changed (TiCDC and DM docs) and the kinds of fixes (wrong values, a parameter name, identifiers). It is specific enough to match the changeset, which fixes values, a parameter name, and identifiers across several TiCDC and DM files. It is somewhat broad, but it refers to real changes and does not describe anything absent from the PR.

Full details: Description check

Explanation

The description follows the repository template. It includes the required 'What is changed' section with a clear before/after table for each fix, the version applicability checkboxes (master and v8.5 ticked), and the AI agent involvement section. It also notes a related issue with dm/quick-start-create-task.md that is reported separately. The template's optional sections (first-time contributor checklist, related PR links) are left blank or unfilled, which is non-critical. The description says it is an automated cherry-pick of #24488, which the template's related-PR field does not link explicitly.

Finishing Touches

Generate unit tests (beta)

  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between 8e822cc and 7376fbf.

Files selected for processing: 8

  • dm/deploy-a-dm-cluster-using-tiup.md
  • dm/dm-export-import-config.md
  • dm/dm-table-routing.md
  • dm/task-configuration-file-full.md
  • migrate-small-mysql-shards-to-tidb.md
  • ticdc/ticdc-csv.md
  • ticdc/ticdc-open-api.md
  • ticdc/ticdc-sink-to-kafka.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants