From 2eea316155618814efb4d8f4faac976d15e460ed Mon Sep 17 00:00:00 2001 From: "grafana-delivery-bot[bot]" <132647405+grafana-delivery-bot[bot]@users.noreply.github.com> Date: Mon, 15 Apr 2024 14:54:11 +0100 Subject: [PATCH] [v11.0.x] docs: update text panel documentation (#86138) docs: update text panel documentation (#84884) * docs: update text panel * Apply suggestions from code review Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com> --------- Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com> (cherry picked from commit 44ae127a6e8fa3db2c11f288fc36777e81f1cb03) Co-authored-by: Marie Cruz --- .../panels-visualizations/visualizations/text/index.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/sources/panels-visualizations/visualizations/text/index.md b/docs/sources/panels-visualizations/visualizations/text/index.md index eb003b96df1..51276ae365a 100644 --- a/docs/sources/panels-visualizations/visualizations/text/index.md +++ b/docs/sources/panels-visualizations/visualizations/text/index.md @@ -23,6 +23,16 @@ weight: 100 Text visualizations enable you to directly include text or HTML in your dashboards. This can be used to add contextual information and descriptions or embed complex HTML. +For example, if you want to display important links to your dashboard, you can use a text visualization to add these links: + +{{< figure src="/static/img/docs/text-panel/text-panel.png" max-width="1025px" alt="A text panel showing important links" >}} + +Use a text visualization when you need to: + +- Add important links or useful annotations. +- Provide instructions or guidance on how to interpret different panels, configure settings, or take specific actions based on the displayed data. +- Announce any scheduled maintenance or downtime that might impact your dashboards. + ## Mode **Mode** determines how embedded content appears.