From 21a4a6e1d4936d1237a495911db2cd42f2282453 Mon Sep 17 00:00:00 2001 From: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com> Date: Mon, 13 May 2024 15:20:25 -0400 Subject: [PATCH] [v10.4.x] docs: update news visualization (#87764) docs: update news visualization (#87443) * docs: update news visualization * docs: add use case * Apply suggestions from code review Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com> * Removed future tense --------- Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com> Co-authored-by: Isabel Matwawana (cherry picked from commit 6fbb35736e338dc5729722f7fd545fe010f07ab3) Co-authored-by: Marie Cruz --- .../visualizations/news/index.md | 28 +++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/docs/sources/panels-visualizations/visualizations/news/index.md b/docs/sources/panels-visualizations/visualizations/news/index.md index b38a82d628b..0c54307a586 100644 --- a/docs/sources/panels-visualizations/visualizations/news/index.md +++ b/docs/sources/panels-visualizations/visualizations/news/index.md @@ -20,12 +20,36 @@ weight: 100 ## News -The news visualization displays an RSS feed. By default, it displays articles from the Grafana Labs blog, and users can change this by entering a different RSS feed URL. +The news visualization displays an RSS feed. By default, it displays articles from the Grafana Labs blog, but you can change this by entering a different RSS feed URL. -Enter the URL of an RSS in the URL field in the Display section. This visualization type does not accept any other queries, and users should not expect to be able to filter or query the RSS feed data in any way using this visualization. +{{< figure src="/static/img/docs/news/news-visualization.png" max-width="1025px" alt="A news visualization showing the latest Grafana news feed" >}} +{{% admonition type="note" %}} In version 8.5, we discontinued the "Use Proxy" option for Grafana news visualizations. As a result, RSS feeds that are not configured for request by Grafana's frontend (with the appropriate [CORS headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)) may not load. +{{% /admonition %}} + +You can use the news visualization to provide regular news and updates to your users. + +## Configure a news visualization + +Once you’ve created a [dashboard](https://grafana.com/docs/grafana//dashboards/build-dashboards/create-dashboard/), enter the URL of an RSS in the [URL](#url) field in the **News** section. This visualization type doesn't accept any other queries, and you shouldn't expect to be able to filter or query the RSS feed data in any way using this visualization. If you're having trouble loading an RSS feed, you can try rehosting the feed on a different server or using a CORS proxy. A CORS proxy is a tool that allows you to bypass CORS restrictions by making requests to the RSS feed on your behalf. You can find more information about using CORS proxies online. If you're unable to display an RSS feed using the news visualization, you can try using the community RSS/Atom data source plugin [RSS/Atom data source](https://grafana.com/grafana/plugins/volkovlabs-rss-datasource/) in combination with the Dynamic text community panel [Dynamic text](https://grafana.com/grafana/plugins/marcusolsson-dynamictext-panel/). This will allow you to display the RSS feed in a different way. + +## Supported data formats + +The news visualization supports RSS and Atom feeds. + +## News options + +Use the following options to refine your news visualization. + +### URL + +The URL of the RSS or Atom feed. + +### Show image + +Controls if the news social image is displayed beside the text content.