-
Notifications
You must be signed in to change notification settings - Fork 704
dashboard: add note about disk warnings #21863
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
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.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Summary of ChangesHello @dveeden, 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 enhances the TiDB Dashboard documentation by providing important context regarding disk information display. It clarifies expected behavior when disk details are unavailable for specific hosts, ensuring users understand that a warning sign in such cases is normal and not indicative of an error. Highlights
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. 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
|
cc @kissmydb |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request adds a note to the TiDB Dashboard documentation explaining why disk information might not be available for some hosts. My review focuses on improving the clarity, conciseness, and style of the new note to align with the documentation style guide. I've suggested a revised version of the note for better readability.
|
||
> **Note:** | ||
> | ||
> The Disk list won't be able to show disk related information for some hosts depending on the component type, partition configuration and deployment method. In these cases a yellow warning sign with an exclamation mark (⚠️) will be shown and a mouse over tooltip of "Failed to get host information" is also shown. This is normal behaviour. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for adding this helpful note. To improve clarity and align with the documentation style guide, I suggest a few changes:123
- The phrasing can be more direct and concise.
- The sentences use passive voice and future tense. It's better to use active voice (or simple present passive) and address the user directly (
you
). - There's a minor spelling inconsistency (
behaviour
vs.behavior
).
Here is a revised version that applies these suggestions:
> The Disk list won't be able to show disk related information for some hosts depending on the component type, partition configuration and deployment method. In these cases a yellow warning sign with an exclamation mark (⚠️) will be shown and a mouse over tooltip of "Failed to get host information" is also shown. This is normal behaviour. | |
> The Disk list might not show disk information for some hosts, depending on the component type, partition configuration, and deployment method. In these cases, a yellow warning icon (⚠️) is displayed. If you hover over the icon, a tooltip with the message "Failed to get host information" appears. This is expected behavior. |
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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?