Skip to content

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+4 −0
Open

dashboard: add note about disk warnings #21863

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions dashboard/dashboard-cluster-info.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,3 +86,7 @@ The list includes the following information:
- Disk Capacity: The total space of the disk on the host on which the instance is running.
- Disk Usage: The space usage of the disk on the host on which the instance is running.
- Instance: The instance running on this host.

> **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.
Copy link

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