Refine tiflash FAQ and configuration docs (#20851)#21495
Refine tiflash FAQ and configuration docs (#20851)#21495ti-chi-bot[bot] merged 4 commits intopingcap:release-8.5from
Conversation
ti-chi-bot
added
lgtm
size/L
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @ti-chi-bot, 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 refines and updates the TiFlash documentation across several key areas. The changes aim to provide clearer, more accurate, and up-to-date information for users, covering topics from accelerating data replication and simplifying configuration to improving troubleshooting procedures and clarifying system requirements. The overall impact is an enhanced and more user-friendly documentation experience for TiFlash.
Highlights
- TiFlash Replication Guidance Updates: Enhanced documentation for accelerating TiFlash replica creation and rebalancing, including new instructions for adjusting
remove-peerlimits in PD Control. - TiFlash Configuration Simplification: Removed outdated PD scheduling parameters and multi-disk deployment guidance for older TiDB versions from the TiFlash configuration documentation.
- TiFlash Troubleshooting Improvements: Restructured and updated the TiFlash troubleshooting guide, particularly for 'TiFlash replica is always unavailable' and 'TiFlash fails to start' sections, and integrated content from the 'Data replication gets stuck' section.
- CPU Instruction Set Requirements: Clarified CPU instruction set requirements (AVX2 for AMD64, ARMv8 for ARM64) for TiFlash deployment in both the overview and troubleshooting guides.
Using Gemini Code Assist
The 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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.
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 or fill out our survey to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request significantly refines the TiFlash documentation, particularly in the FAQ and configuration sections. The reorganization of the troubleshooting guide is a major improvement, providing a much clearer and more structured approach for users. The removal of outdated information and clarification of parameters enhance the accuracy and relevance of the documents. My review includes a few minor suggestions to further improve clarity, grammar, and adherence to the style guide. Overall, this is a high-quality contribution to the documentation. I have made a few suggestions based on the documentation style guide.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
/approve |
|
[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 DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
3 participants
This is an automated cherry-pick of #20851
First-time contributors' checklist
What is changed, added or deleted? (Required)
remove-peerrestriction when rebalancing Regions from old to new TiFlash nodes.profiles.default.max_memory_usage_for_all_queriessince v6.6.0.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)?
Do your changes match any of the following descriptions?