docs icon indicating copy to clipboard operation
docs copied to clipboard

resource control: support more mode for BURSTABLE

Open lhy1024 opened this issue 6 months ago • 2 comments

First-time contributors' checklist

What is changed, added or deleted? (Required)

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)
  • [ ] 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: https://github.com/pingcap/docs-cn/pull/20020
  • 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

lhy1024 avatar Jun 06 '25 10:06 lhy1024

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

In response to this:

Code Review

This pull request updates the documentation to reflect the new modes available for the BURSTABLE option in resource groups. The changes are mostly in table outputs and descriptions across several files. Overall, the updates clarify the new functionality. However, there are a few areas that need attention to ensure accuracy and consistency, primarily related to example outputs and a typo.

Summary of Findings

  • Documentation Accuracy: There's an incorrect row count in the DESC resource_groups; output in information-schema/information-schema-resource-groups.md.
  • Spelling Error: A typo "UNLIMTED" was found in sql-statements/sql-statement-create-resource-group.md. It should be "UNLIMITED".
  • Example Consistency: In tidb-resource-control-ru-groups.md, an example description refers to rg1 while the SQL code creates rg4.
  • Readability: The description of the BURSTABLE option is quite long in several files and could be broken down for better readability.
  • Formatting Consistency: EBNF diagrams in sql-statement-alter-resource-group.md and sql-statement-create-resource-group.md have inconsistent indentation for the new BURSTABLE options.

Merge Readiness

The pull request introduces important documentation updates for the BURSTABLE resource control option. While the changes are largely good, there are a few issues related to accuracy (incorrect command output, typo) and consistency (example naming) that should be addressed before merging. Addressing these will improve the clarity and correctness of the documentation. I am unable to approve pull requests, so please ensure these changes are reviewed and approved by a maintainer.

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 Jun 06 '25 10:06 ti-chi-bot[bot]

@songrijie: 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 Jun 27 '25 10:06 ti-chi-bot[bot]

[LGTM Timeline notifier]

Timeline:

  • 2025-06-27 03:00:45.405096267 +0000 UTC m=+1018298.128275246: :ballot_box_with_check: agreed by lilin90.
  • 2025-07-03 02:35:33.001444692 +0000 UTC m=+1535185.724623687: :ballot_box_with_check: agreed by hfxsd.

ti-chi-bot[bot] avatar Jul 03 '25 02:07 ti-chi-bot[bot]

This PR is ready for merging.

lilin90 avatar Jul 14 '25 06:07 lilin90

/unhold

lilin90 avatar Aug 19 '25 07:08 lilin90

/approve

lilin90 avatar Aug 19 '25 08:08 lilin90

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lilin90

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 Aug 19 '25 08:08 ti-chi-bot[bot]

/hold

lilin90 avatar Aug 19 '25 08:08 lilin90