Repository navigation
Conversation
…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>
|
Skipping CI for Draft Pull Request. |
ti-chi-bot
Bot
added
the
do-not-merge/work-in-progress
|
No actionable comments were generated in the recent review.
 |
| Layer / File(s) | Summary |
|---|---|
DM documentation corrections 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 |
Clarified that the TiUP deployment note concerns a DM cluster, capitalized the “Import” heading, and corrected column names in table-routing guidance and configuration examples. |
TiCDC documentation
| Layer / File(s) | Summary |
|---|---|
TiCDC documentation corrections ticdc/ticdc-csv.md, ticdc/ticdc-open-api.md, ticdc/ticdc-sink-to-kafka.md |
Updated the documented TIME format to HH:mm:ss, corrected the replication task list API description, and corrected the TLS parameter and partition-dispatcher example description. |
Priority:
Estimated code review effort: 1 (Trivial) | ~5 minutes
Change: Other
Suggested reviewers: qiancai
Merge Risk: 
7fb57
-
These documentation updates are mergeable; no current-head issue requiring remediation was found.
Architecture risk: 
1d623
-
The change affects 2 systems.
Changed systems:
dm,ticdcArchitecture concerns
No architecture-level concerns identified.Review details
-
Systems and components
- observed — dm (service) was modified; 3 changed files map to changed impact.
- observed — ticdc (service) was modified; 3 changed files map to changed impact.
Before / after behavior
- observed — Modified behavior in dm/deploy-a-dm-cluster-using-tiup.md: Clarified that secret-key or interactive-password authentication applies when deploying a DM cluster with TiUP, replacing the previous TiDB deployment reference.
- observed — Modified behavior in dm/dm-export-import-config.md: Capitalized the “Import” heading; the section content is otherwise unchanged.
- observed — Modified behavior in dm/dm-table-routing.md: Corrected the column name in the warning from
c-tabletoc_table. - observed — Modified behavior in dm/dm-table-routing.md: Corrected the column name in the warning from
c-sourcetoc_source.
-
Pre-merge checks: 
-
Check name Status Explanation Description check The description identifies all documentation corrections, affected versions, AI involvement, and unchanged related-file scope. The required sections are present and sufficiently complete. Title check The title clearly summarizes the main documentation fixes in the TiCDC and DM areas, including incorrect values, a parameter name, and identifiers. Docstring Coverage No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat… Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request. Full details: Docstring Coverage
-
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (3 skipped: 3 unsupported.)
-
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.
Comment @coderabbitai help to get the list of available commands.
ti-chi-bot
Bot
added
the
missing-translation-status
ti-chi-bot
Bot
added
the
size/S
ti-chi-bot
Bot
removed
the
do-not-merge/work-in-progress
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
- Configuration used: Repository: pingcap/docs/.coderabbit.yaml
- Review profile: ASSERTIVE
- Plan: Advanced
- Run ID:
9c183b48-00bb-403e-94da-fd87b9c70594
📒 Files selected for processing: 6
dm/deploy-a-dm-cluster-using-tiup.mddm/dm-export-import-config.mddm/dm-table-routing.mdticdc/ticdc-csv.mdticdc/ticdc-open-api.mdticdc/ticdc-sink-to-kafka.md
Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 1 remain after this review.
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>
ti-chi-bot
Bot
removed
the
missing-translation-status
| > If any of the following errors occur, source information of sharded tables and schemas might fail to be written to the merged table. | ||
|
|
||
| - `c-table` is not in the last three columns: | ||
| - `c_table` is not in the last three columns: |
There was a problem hiding this comment.
The same wrong identifier still exists in dm/task-configuration-file-full.md:65 — the comment there says "written to the c-table column of the merged table" while the YAML right below it correctly shows target-column: "c_table". Since this PR fixes c-table/c-source in this file, a follow-up fix in that sibling file would keep the docs consistent.
There was a problem hiding this comment.
Thanks! Fixed in 7fb5768. The same c-table also appeared in the extract-table comment of migrate-small-mysql-shards-to-tidb.md:152, so I fixed it there too.
[LGTM Timeline notifier]Timeline:
|
qiancai
added
the
needs-cherry-pick-release-8.5
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
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.
test1table" (the matcher istest1.*)test1database"-enable-tls=trueparameter to--sink-uri"enable-tls=true(the sink URI parameter table saysenable-tls)TIME: "Format:yyyy-MM-dd" (the example is"23:59:59")HH:mm:ssc-table,c-sourcec_table,c_source(as in the DDL)The "Start downstream TiDB" commands in
dm/quick-start-create-task.mdalso 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.
What is the related PR or file link(s)?
AI agent involvement
Do your changes match any of the following descriptions?
🤖 Generated with Claude Code
Summary by CodeRabbit
TIMEformat toHH:mm:ss.