From 78fb08ef38e2eb1dec18a75fe2c5ec98ea5001d8 Mon Sep 17 00:00:00 2001 From: Pratik Mankawde <3397372+pratikmankawde@users.noreply.github.com> Date: Sat, 4 Jul 2026 02:32:23 +0100 Subject: [PATCH] docs(telemetry): dashboard-level descriptions to plain text Grafana renders the dashboard-level description as plain text (not markdown), so the h6 headings/italics showed as literal characters. Convert to plain 'What this shows:' / 'Use it to:' labeled lines. Panel descriptions (which DO render markdown) are unchanged. Co-Authored-By: Claude Opus 4.8 --- .../telemetry/grafana/dashboards/system-ledger-data-sync.json | 2 +- docker/telemetry/grafana/dashboards/system-network-traffic.json | 2 +- .../grafana/dashboards/system-overlay-traffic-detail.json | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docker/telemetry/grafana/dashboards/system-ledger-data-sync.json b/docker/telemetry/grafana/dashboards/system-ledger-data-sync.json index ca6d46421e..19d6e6c441 100644 --- a/docker/telemetry/grafana/dashboards/system-ledger-data-sync.json +++ b/docker/telemetry/grafana/dashboards/system-ledger-data-sync.json @@ -2,7 +2,7 @@ "annotations": { "list": [] }, - "description": "###### What this shows:\n*Ledger data exchange and object-fetch traffic between this node and its peers: ledger sync, tree-node retrieval, and transaction-set exchange.*\n\n###### Use it to:\n*See how much ledger data the node is pulling or serving and spot catch-up activity.*", + "description": "What this shows: Ledger data exchange and object-fetch traffic between this node and its peers: ledger sync, tree-node retrieval, and transaction-set exchange.\nUse it to: See how much ledger data the node is pulling or serving and spot catch-up activity.", "editable": true, "fiscalYearStartMonth": 0, "graphTooltip": 1, diff --git a/docker/telemetry/grafana/dashboards/system-network-traffic.json b/docker/telemetry/grafana/dashboards/system-network-traffic.json index dad1ba1c55..001258131d 100644 --- a/docker/telemetry/grafana/dashboards/system-network-traffic.json +++ b/docker/telemetry/grafana/dashboards/system-network-traffic.json @@ -2,7 +2,7 @@ "annotations": { "list": [] }, - "description": "###### What this shows:\n*Peer connectivity and overlay bandwidth for this node: peer counts, disconnects, total bytes and messages exchanged, and the transaction, proposal, and validation traffic that flows across the peer-to-peer network.*\n\n###### Use it to:\n*Gauge peer health and overall overlay bandwidth and see which message types dominate network traffic.*", + "description": "What this shows: Peer connectivity and overlay bandwidth for this node: peer counts, disconnects, total bytes and messages exchanged, and the transaction, proposal, and validation traffic that flows across the peer-to-peer network.\nUse it to: Gauge peer health and overall overlay bandwidth and see which message types dominate network traffic.", "editable": true, "fiscalYearStartMonth": 0, "graphTooltip": 1, diff --git a/docker/telemetry/grafana/dashboards/system-overlay-traffic-detail.json b/docker/telemetry/grafana/dashboards/system-overlay-traffic-detail.json index db00f78335..a204adef1c 100644 --- a/docker/telemetry/grafana/dashboards/system-overlay-traffic-detail.json +++ b/docker/telemetry/grafana/dashboards/system-overlay-traffic-detail.json @@ -2,7 +2,7 @@ "annotations": { "list": [] }, - "description": "###### What this shows:\n*Fine-grained breakdown of peer-to-peer overlay traffic beyond the main network view: squelch relay control, protocol overhead, validator-list distribution, transaction-set exchange, transaction availability, ledger-proof and replay traffic, and unclassified messages.*\n\n###### Use it to:\n*Drill into individual overlay message categories to diagnose relay efficiency, overhead, and catch-up traffic.*", + "description": "What this shows: Fine-grained breakdown of peer-to-peer overlay traffic beyond the main network view: squelch relay control, protocol overhead, validator-list distribution, transaction-set exchange, transaction availability, ledger-proof and replay traffic, and unclassified messages.\nUse it to: Drill into individual overlay message categories to diagnose relay efficiency, overhead, and catch-up traffic.", "editable": true, "fiscalYearStartMonth": 0, "graphTooltip": 1,