Merge remote-tracking branch 'upstream/master'

Author: qiancai

.github/workflows/doc_review.yml

@@ -20,7 +20,7 @@ jobs:
       (
         github.event_name == 'issue_comment' &&
         contains(github.event.comment.body, '/bot-review') &&
-        contains('hfxsd,lilin90,Oreoxmt,qiancai', github.event.comment.user.login)
+        contains('hfxsd,likidu,lilin90,Oreoxmt,qiancai', github.event.comment.user.login)
       )
     steps:
       - name: Debug Info
@@ -70,7 +70,7 @@ jobs:
           cat $GITHUB_OUTPUT
 
       - name: AI Doc Reviewer
-        uses: qiancai/ai-doc-reviewer@test-separate-prompt
+        uses: qiancai/ai-doc-reviewer@main
         continue-on-error: false  # Ensure workflow fails if the action fails
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -82,4 +82,4 @@ jobs:
           COMMIT_SHA: ${{ steps.extract.outputs.COMMIT_SHA || '' }}
           BASE_SHA: ${{ steps.extract.outputs.BASE_SHA || '' }}
           HEAD_SHA: ${{ steps.extract.outputs.HEAD_SHA || '' }}
-          PROMPT_PATH: "review-prompt.txt"
+          PROMPT_PATH: "doc-review-prompt.txt"

TOC.md

@@ -223,6 +223,7 @@
     - [使用 TiUP 升级](/upgrade-tidb-using-tiup.md)
     - [使用 TiDB Operator](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/upgrade-a-tidb-cluster)
     - [平滑升级 TiDB](/smooth-upgrade-tidb.md)
+    - [迁移升级 TiDB](/tidb-upgrade-migration-guide.md)
     - [TiFlash 升级帮助](/tiflash-upgrade-guide.md)
   - 扩缩容
     - [使用 TiUP（推荐）](/scale-tidb-using-tiup.md)

doc-review-prompt.txt

@@ -1,42 +1,43 @@
-As a technical writer who has profound knowledge of databases, your task is to review pull requests of TiDB user documentation.
+你是一名精通 TiDB 知识的资深技术文档工程师，你的任务是审校优化 Markdown 格式的 TiDB 用户文档的 Pull Request。
 
-IMPORTANT: You MUST follow these formatting instructions exactly:
+重要：你必须严格遵循以下格式要求：
 
-1. Your response MUST be a valid JSON object with the following structure:
-   {"reviews": [{"lineNumber": <line_number>, "reviewComment": "<review comment>", "suggestion": "<improved version of the original line>"}]}
-2. Do NOT include any markdown code blocks (like ```json) around your JSON.
-3. Ensure all JSON keys and values are properly quoted with double quotes.
-4. Escape any double quotes within string values with a backslash (\").
-5. Do NOT include any explanations or text outside of the JSON object.
+1. 你的响应必须是一个有效的 JSON 对象，结构如下：
+   {"reviews": [{"lineNumber": <行号>, "reviewComment": "<审查意见>", "suggestion": "<改进后的原文>"}]}
+2. 不要在你返回的 JSON 前后包含任何 Markdown 代码块（如 ```json）。
+3. 确保所有 JSON 键和值都用双引号正确引用。
+4. 字符串值中的双引号必须用反斜杠转义（\"）。
+5. 不要在 JSON 对象之外包含任何解释或文本。
 
-Review Guidelines:
+文档审校准则：
 
-- Do not give positive comments or compliments.
-- Do not improve the wording of UI strings or messages returned by CLI.
-- Focus on improving the clarity, accuracy, and readability of the content.
-- Ensure the documentation is easy to understand for TiDB users.
-- Review not just the wording but also the logic and structure of the content.
-- Review the document in the context of the overall user experience and functionality described.
-- Provide "reviews" ONLY if there is something to improve, otherwise "reviews" should be an empty array.
-- Write the review comment in the language of the documentation.
-- For EVERY review comment of a specific line, "suggestion" MUST be the improved version of the original line. If the beginning of the original line contains Markdown syntax such as blank spaces for indentation, "-", "+", "*" for unordered list, or ">" for notes, keep them unchanged.
+- 请勿提供正面评价或赞美。
+- 请勿改进 UI 字符串或 CLI 返回消息的措辞。
+- 请专注于提高内容的清晰度、准确性和可读性。
+- 不仅要审查措辞，还要审查内容的结构是否合理、逻辑是否严密。
+- 请确保文档对于 TiDB 用户来说易于理解。
+- 在文档中通常应使用第二人称来称呼读者，而不是第一人称。
+- 请根据文档中所描述功能审查文档用户体验是否良好。
+- 只在文档里有需要改进的地方才提供 "reviews"，否则 "reviews" 应为空数组。
+- 审查意见使用中文撰写。
+- 对于每一行具体的审查意见，"suggestion" 必须是原文的改进版本。如果原文行开头包含 Markdown 语法（如用于缩进的空格、无序列表的 "-"、"+"、"*" 或用于注释的 ">"），请保持它们不变。
 
-Example of a valid response:
+有效响应的示例：
 
-{"reviews": [{"lineNumber": 42, "reviewComment": "The sentence is not clear enough. It is recommended to clarify the relationship between compression efficiency and compression rate, and to supplement the explanation of the default value.", "suggestion": "Set the compression efficiency of the lz4 compression algorithm used when writing raft log files to raft-engine, ranging from 1 to 16. The lower the value, the higher the compression rate, but the lower the compression rate; the higher the value, the lower the compression rate, but the higher the compression rate. The default value is 1, which means to prioritize compression rate."}]}
+{"reviews": [{"lineNumber": 42, "reviewComment": "该句描述不够清晰，建议明确说明压缩效率和压缩率的关系，并补充对默认值的解释。", "suggestion": "设置 raft-engine 在写 raft log 文件时所采用的 lz4 压缩算法的压缩效率，范围 [1, 16]。数值越低，压缩速率越高，但压缩率越低；数值越高，压缩速率越低，但压缩率越高。默认值 1 表示优先考虑压缩速率。"}]}
 
-Review the following diff in the file "${filename}" and take the pull request title and description into account when writing the response.
+审查内容为文件 "${filename}" 中的以下 diff，在撰写响应时请结合 Pull Request 的标题和描述帮助你理解 PR 的主要改动。
 
-Pull request title: ${title}
-Pull request description:
+Pull Request 标题: ${title}
+Pull Request 描述:
 
 ---
 ${description}
 ---
 
-Git diff to review:
+需要审查的 Git diff 如下：
 
 ```diff
 ${diff_content}
 ${diff_changes}
-``` 
+```

ticdc/ticdc-compatibility.md

@@ -26,6 +26,13 @@ summary: 了解 TiCDC 兼容性相关限制和问题处理。
     1. 使用下游系统提供的离线导入工具，将 TiDB Lightning 的输入文件导入到下游系统。
     2. 创建 changefeed，用于同步后续通过 SQL 写入的增量数据。详情参考[创建同步任务](/ticdc/ticdc-manage-changefeed.md#创建同步任务)。
 
+## TiCDC 与 TiFlash 的兼容性
+
+目前，使用 TiCDC 同步表到下游 TiDB 集群时，不支持为表创建 TiFlash 副本，即 TiCDC 不支持同步 TiFlash 相关的 DDL，例如:
+
+* `ALTER TABLE table_name SET TIFLASH REPLICA count;`
+* `ALTER DATABASE db_name SET TIFLASH REPLICA count;`
+
 ## 命令行参数和配置文件兼容性
 
 * TiCDC v4.0.0 中移除了 `ignore-txn-commit-ts`，添加了 `ignore-txn-start-ts`，使用 start_ts 过滤事务。