Skip to content
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

Update hidden_explanation to include labels #23473

Draft
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

NoRi2909
Copy link
Contributor

Currently the explanation for switching off "Visible" for entities is as follows:

image

The first part of the explanation is misleading as it says "… will not be shown on your dashboard …".

  1. There are multiple dashboards today, so there is not a single one like this is implying.
  2. You can still place any hidden entity on your dashboards.
  3. So this refers to the auto-populated"Default dashboard" type, only.

Proposed change

The most important result of hiding an entity is that it is no longer included when its area, device or label is referenced.

This PR adds labels to the explanation and drops the (obvious) part about the auto-populated dashboard that is misleading regarding all custom dashboards.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (thank you!)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • The code change is tested and works locally.
  • There is no commented out code in this PR.
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

The most important result of hiding an entity is that it no longer included when its area, device or label is referenced.

This commit adds labels to the explanation and drops the (obvious) part about the auto-populated dashboard that is misleading regarding all custom dashboards.
@MindFreeze
Copy link
Contributor

Not sure if entirely removing the dashboard mention is ok but clarifying it is not easy either

@NoRi2909
Copy link
Contributor Author

Yes, a difficult decision. But as soon as you mention the word "dashboard" again you need to add quite some explanation that they do in fact not disappear from any user-created dashboard.

The auto-populated dashboard is for absolute novices, and they will either not touch that setting at all or when they turn off the "Visible" switch they will kind of expect them to be not included in the automatic dashboard.

@NoRi2909
Copy link
Contributor Author

NoRi2909 commented Dec 29, 2024

Digging further into the Dashboard issue I noticed that we have a duplicate use of "Default" regarding Dashboards:

The pre-populated dashboard is currently called "Default dashboard"

Screenshot 2024-12-29 13 41 29

and the one that shows up at the top of the Sidebar is also called "Default":

Screenshot 2024-12-29 13 42 26

Historically this was probably the same but it is no longer. Therefore we should first rename the "Default dashboard" to "Automatic dashboard" or similar. And then it should be easier to keep the line:

"Hidden entities will not be included in an automatic dashboard or when their area, device or label is referenced. …"

@NoRi2909 NoRi2909 marked this pull request as draft December 29, 2024 21:08
@NoRi2909
Copy link
Contributor Author

I have created the new PR #23508 to rename the "Default dashboard" to "Automatic dashboard" so we could use this term here as suggested above.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Entity settings: Misleading explanation for hidden entities regarding dashboards
2 participants