docs icon indicating copy to clipboard operation
docs copied to clipboard

br: disable restore checksum

Open Tristan1900 opened this issue 8 months ago • 5 comments

First-time contributors' checklist

What is changed, added or deleted? (Required)

Chinese version https://github.com/pingcap/docs-cn/pull/20256

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.

  • [x] master (the latest development version)
  • [x] v9.0 (TiDB 9.0 versions)
  • [ ] v8.5 (TiDB 8.5 versions)
  • [ ] v8.4 (TiDB 8.4 versions)
  • [ ] v8.3 (TiDB 8.3 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)
  • [ ] v6.1 (TiDB 6.1 versions)
  • [ ] v5.4 (TiDB 5.4 versions)

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

  • This PR is translated from:
  • Other reference link(s):

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

Tristan1900 avatar Apr 24 '25 18:04 Tristan1900

@gemini-code-assist[bot]: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

Code Review

The pull request introduces changes to the documentation for the BR tool, specifically focusing on disabling checksums by default and providing more information about checksum configuration. The changes seem well-organized and provide useful information to the user. However, there are a few areas where the clarity and consistency can be improved.

Summary of Findings

  • Clarity and Consistency: Ensure consistent terminology and clear explanations throughout the documentation, especially when introducing new concepts like checksum levels. Also, ensure that the documentation is easy to understand for TiDB users.[^1]
  • Sentence Structure and Flow: Improve sentence structure and logical flow to enhance readability and comprehension. Make sure the documentation is easy to understand for TiDB users.[^1]
  • Markdown Style: Ensure adherence to markdown style guidelines, including proper heading hierarchy and spacing. Add a blank line before and after headings and lists.[^2]

Merge Readiness

The pull request is almost ready for merging. Addressing the comments related to clarity, consistency, and markdown style will further improve the quality of the documentation. I am unable to approve the pull request, and users should have others review and approve this code before merging. I recommend addressing the comments before merging.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

ti-chi-bot[bot] avatar Apr 24 '25 18:04 ti-chi-bot[bot]

@BornChanger: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

ti-chi-bot[bot] avatar Apr 28 '25 06:04 ti-chi-bot[bot]

/bot-review

hfxsd avatar May 30 '25 02:05 hfxsd

✅ AI review completed, 9 comments generated.

github-actions[bot] avatar May 30 '25 02:05 github-actions[bot]

[LGTM Timeline notifier]

Timeline:

  • 2025-11-21 03:35:30.448303207 +0000 UTC m=+241894.097497664: :ballot_box_with_check: agreed by hfxsd.

ti-chi-bot[bot] avatar Nov 21 '25 03:11 ti-chi-bot[bot]

/approve

hfxsd avatar Nov 21 '25 03:11 hfxsd

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hfxsd

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

The pull request process is described here

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

ti-chi-bot[bot] avatar Nov 21 '25 03:11 ti-chi-bot[bot]