Add help text to visualization/Dashboard panel notes

[noamgal]

Will be helpful to add some static text to a visualization, it can be displayed as a tooltip or as a tab in the detailed information (next to "Response" and "statistics")
Plus, adding some subtitle (below visulaization's name) can be nice.

[ppf2]

It will also be helpful (on a related note) to provide a text component (with html support) where it can be dropped anywhere in the dashboard to display instructional or descriptive text. Like sometimes it can be helpful to display help text (that includes a link to an external system).

[vikrim1]

+1

[rashidkpc]

Really this should be a parameter of anything that exports panels to the dashboard. There should be a help icon on any panel that has exported help text. Clicking it should toggle between the help text and the panel content.

[tbragin]

We already have a "description" field in the saved object itself which we don't expose anywhere in the UI, afaik.

[FraJern]

+1
this would be great. building dashboards that are sent all over the place. tech naming of searches is not always as explanatory as one would think ;-). So to enable others, that are not familiar with the data, to read the visualizations as they are meant this would be great.

[crisal24]

+1

[fbaligand]

+1

[victoriatomzik]

Pardon my french, but this issue was created 5 years ego. If it was a good first issue, it would have been solved by then. I unfortunately think that this comment applies to majority of this repo's good first issues. Maybe it's time to critically review them? Adding this label improperly can be misleading.

[timroes]

Hi, thanks for your comment. good first issue labels are in the responsibility of the appropriate team for that issue (indicated by the Team:* label on that issue). I can not speak for all teams, but at least for the Kibana App team here: I periodically review all our good first issues and label/unlabel them as appropriate. I currently don't see many that would break our usage of the good first issue in the repository. Usually for me that means: the issue does not require larger involvement from the design team, the issue does not depend or require significant architectural changes, so basically "it's good to go" and be solveable without very deep knowledge about the architecture (you'll always still need some understanding of the code and functioning though, but I mean that's something you can't avoid for any issue). I am usually when onboarding new people to the project looking through the good first issues and so far they were always rather easy to solve when a new person joins the team. Sometimes it happens that during that issue you'll still find out that the assumption about how easy it will fit into the architecture might not be true, and only figure out during solving it, that it's actually not a good first issue, that happens sometimes, but luckily not that often. That there are still a lot of old issues left (despite them haven't been labelled like that forever) simply boils down to prioritization. We have a lot of them, after people are properly onboarded we're using our regular prioritization process and roadmap planning, and it can simply be a specific good first issue is not high enough in the priority list to be addressed. In conclusion, I currently don't see that we have misslabeled a lot of them, but I am happy to review issues in doubt, e.g. this very issue wouldn't have always been qualified for that, basically only since the embeddable and panel actions architectural introduction this is rather easy to address (beforehand it would have been significantly harder to implement this, because there was no available infrastructure you could "just plug it in").

Cheers,
Tim

[nreese]

@timroes Can this be closed by #78918? Lens descriptions are now displayed in a tooltip of dashboard panels.

[timroes]

@nreese Yes I think it can, thanks.

[nivigrey]

is this feature disabled for version 7.16.2? I don't find any options to add notes to my visualization (lens description)?

[KeithTt]

@tbragin Is there a way about how to cutomize or overwrite the value of description field?