statistics: deprecate stats v1 in 8.5 docs#22624
statistics: deprecate stats v1 in 8.5 docs#226240xPoe wants to merge 9 commits intopingcap:release-8.5from
Conversation
|
[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 |
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request updates the TiDB 8.5 documentation to formally deprecate Statistics Version 1 ( Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request effectively documents the deprecation of Statistics Version 1 across several files. The changes are clear and the updated SQL examples for migration are correct.
My review includes a few minor suggestions to improve the wording for better clarity and directness, aligning with the repository's documentation style guide. Specifically, I've recommended using a more active voice (e.g., 'You should use...' instead of 'It is recommended that you use...') to make the instructions for users more direct. These are minor stylistic improvements to an already solid update.
|
|
||
| > **Warning:** | ||
| > | ||
| > Statistics Version 1 (`tidb_analyze_version = 1`) is deprecated and will be removed in a future release. It is recommended that you use Statistics Version 2 (`tidb_analyze_version = 2`). |
There was a problem hiding this comment.
To be more direct and align with the documentation style guide's preference for the second person ('you'), I suggest rephrasing this sentence.
| > Statistics Version 1 (`tidb_analyze_version = 1`) is deprecated and will be removed in a future release. It is recommended that you use Statistics Version 2 (`tidb_analyze_version = 2`). | |
| > Statistics Version 1 (`tidb_analyze_version = 1`) is deprecated and will be removed in a future release. You should use Statistics Version 2 (`tidb_analyze_version = 2`). |
References
- The style guide recommends addressing users directly in the second person ('you') and avoiding passive voice. The suggestion improves directness by changing a passive recommendation to an active one. (link)
|
|
||
| > **Warning:** | ||
| > | ||
| > Statistics Version 1 (`tidb_analyze_version = 1`) is deprecated and will be removed in a future release. It is recommended that you use Statistics Version 2 (`tidb_analyze_version = 2`). For details, see [Introduction to Statistics](/statistics.md#versions-of-statistics). |
There was a problem hiding this comment.
To be more direct and align with the documentation style guide's preference for the second person ('you'), I suggest rephrasing this sentence.
| > Statistics Version 1 (`tidb_analyze_version = 1`) is deprecated and will be removed in a future release. It is recommended that you use Statistics Version 2 (`tidb_analyze_version = 2`). For details, see [Introduction to Statistics](/statistics.md#versions-of-statistics). | |
| > Statistics Version 1 (`tidb_analyze_version = 1`) is deprecated and will be removed in a future release. You should use Statistics Version 2 (`tidb_analyze_version = 2`). For details, see [Introduction to Statistics](/statistics.md#versions-of-statistics). |
References
- The style guide recommends addressing users directly in the second person ('you') and avoiding passive voice. The suggestion improves directness by changing a passive recommendation to an active one. (link)
|
@AilinKid: adding LGTM is restricted to approvers and reviewers in OWNERS files. DetailsIn 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. |
What is changed, added or deleted? (Required)
Document that Statistics Version 1 (
tidb_analyze_version = 1) is deprecated and will be removed in a future release across the statistics, ANALYZE, and analyze status docs. Align the migration query examples with v1 -> v2 migration.Which TiDB version(s) do your changes apply to? (Required)
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?