Skip to content

Conversation

dveeden
Copy link
Contributor

@dveeden dveeden commented Oct 1, 2025

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.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 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

@dveeden dveeden requested review from hfxsd and Oreoxmt October 1, 2025 07:32
Copy link

ti-chi-bot bot commented Oct 1, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign overvenus for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Copy link

Summary of Changes

Hello @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

  • Documentation Update: Added a note to the dashboard-cluster-info.md file explaining why disk-related information might not be displayed for certain hosts and clarifying that a "Failed to get host information" warning is expected behavior in these scenarios.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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. 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

  1. 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.

@ti-chi-bot ti-chi-bot bot added the missing-translation-status This PR does not have translation status info. label Oct 1, 2025
@dveeden
Copy link
Contributor Author

dveeden commented Oct 1, 2025

cc @kissmydb

@ti-chi-bot ti-chi-bot bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Oct 1, 2025
Copy link

@gemini-code-assist gemini-code-assist bot left a 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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

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:

Suggested change
> 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.

Style Guide References

Footnotes

  1. The documentation should be clear, simple, and readable.

  2. The style guide recommends writing in the second person ('you') and using the present tense.

  3. The style guide advises against overusing the passive voice.

@dveeden
Copy link
Contributor Author

dveeden commented Oct 1, 2025

Some examples:

TiUP Playground:
image

TiDB Operator/k8s:
image

Looks like this uses http://127.0.0.1:2379/dashboard/api/host/all which responds like this:
image

So it has instances with type and partition and then a list of partitions with path, fstype, etc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant