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

Add Business Text 5.0.0 blog #696

Merged
merged 8 commits into from
Jun 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion blog/2022-11-27-dynamictext-panel-2.1.0/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
authors: [mikhail]
slug: dynamictext-panel-2.1.0-20221127/
tags: [Dynamic Text, Business Suite]
tags: [Business Text, Business Suite]
image: /img/blog/2022-11-27-dynamictext-panel-2.1.0/banner.png
keywords: [Dynamic Text, Panel, Data, Grafana]
updated: 2023-09-15
Expand Down
2 changes: 1 addition & 1 deletion blog/2023-01-10-dynamictext-panel-2.2.0/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
authors: [mikhail]
slug: dynamictext-panel-2.2.0-20230110/
tags: [Dynamic Text, Business Suite]
tags: [Business Text, Business Suite]
image: /img/blog/2023-01-10-dynamictext-panel-2.2.0/banner.png
keywords: [Dynamic Text, Panel, Data, Grafana]
updated: 2023-09-15
Expand Down
2 changes: 1 addition & 1 deletion blog/2023-02-19-dynamictext-panel-3.0.0/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
authors: [mikhail]
slug: dynamictext-panel-3.0.0-20230219/
tags: [Dynamic Text, Business Suite]
tags: [Business Text, Business Suite]
image: /img/blog/2023-02-19-dynamictext-panel-3.0.0/banner.png
keywords: [Dynamic Text, Panel, Data, Code, Highlight, Grafana]
updated: 2023-09-15
Expand Down
2 changes: 1 addition & 1 deletion blog/2023-03-12-dynamictext-panel-3.1.0/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
authors: [mikhail]
slug: dynamictext-panel-3.1.0-20230312/
tags: [Dynamic Text, Business Suite]
tags: [Business Text, Business Suite]
image: /img/blog/2023-03-12-dynamictext-panel-3.1.0/banner.png
keywords: [Dynamic Text, Panel, Data, Code, Highlight, Grafana]
updated: 2023-09-15
Expand Down
2 changes: 1 addition & 1 deletion blog/2023-07-09-dynamictext-panel-4.0.0/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
authors: [mikhail]
slug: dynamictext-panel-4.0.0-20230709/
tags: [Dynamic Text, Business Suite]
tags: [Business Text, Business Suite]
image: /img/blog/2023-07-09-dynamictext-panel-4.0.0/banner.png
keywords: [Dynamic Text, Panel, JavaScript, Events, Grafana]
updated: 2023-09-15
Expand Down
2 changes: 1 addition & 1 deletion blog/2023-07-31-dynamictext-panel-4.1.0/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
authors: [mikhail]
slug: dynamictext-panel-4.1.0-20230731/
tags: [Dynamic Text, Business Suite]
tags: [Business Text, Business Suite]
image: /img/blog/2023-07-31-dynamictext-panel-4.1.0/banner.png
keywords: [Dynamic Text, Panel, JavaScript, Events, Grafana]
updated: 2023-09-15
Expand Down
2 changes: 1 addition & 1 deletion blog/2023-11-21-dynamictext-panel-4.2.0/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
authors: [daria]
slug: dynamictext-panel-4.2.0-20231121/
tags: [Dynamic Text, Business Suite]
tags: [Business Text, Business Suite]
image: /img/blog/2023-11-21-dynamictext-panel-4.2.0/banner.png
keywords: [Dynamic Text, Panel, JavaScript, Events, Grafana]
---
Expand Down
2 changes: 1 addition & 1 deletion blog/2024-01-12-dynamictext-panel-4.3.0/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
authors: [daria]
slug: dynamictext-panel-4.3.0-20240108/
tags: [Dynamic Text, Business Suite]
tags: [Business Text, Business Suite]
image: /img/blog/2024-01-12-dynamictext-panel-4.3.0/banner.png
keywords: [Dynamic Text, Panel, JavaScript, Events, Grafana]
---
Expand Down
2 changes: 1 addition & 1 deletion blog/2024-01-21-dynamic-text-d3-community/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ authors:
image_url: https://avatars.githubusercontent.com/u/5258222?v=4
title: Solutions Director at Cognizant
slug: dynamic-text-d3-community-20240121/
tags: [Dynamic Text, Community]
tags: [Business Text, Community]
image: /img/blog/2024-01-21-dynamic-text-d3-community/banner.png
keywords: [Grafana, API, Business]
---
Expand Down
2 changes: 1 addition & 1 deletion blog/2024-03-02-anonymizer/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
authors: [daria]
slug: anonymizer-20240302/
tags: [Dynamic Text, Solution]
tags: [Business Text, Solution]
image: /img/blog/2024-03-02-anonymizer/banner.png
keywords: [Dynamic Text, Anonymizer]
---
Expand Down
198 changes: 198 additions & 0 deletions blog/2024-06-19-dynamictext-panel-5.0.0/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,198 @@
---
authors: [daria]
slug: dynamictext-panel-5.0.0-20240619/
tags: [Business Text, Business Suite]
image: /img/blog/2024-06-19-dynamictext-panel-5.0.0/banner.png
keywords: [Dynamic Text, Panel, JavaScript, Grafana]
---

import Image from "@theme/Image";
import Shorts from "@theme/Shorts";
import Video from "@theme/Video";

# Business Text Panel 5.0.0

We're excited to announce the release of the Business Text Panel 5.0.0. This release includes the following updates:

- Plugin rebranding, the new name is the **Business Text Panel**.
- Replaced the **External Resource**->**Scripts** (external JavaScript) with importing via the code. **Breaking change**.
- Non`context` code parameters are retired. Please update the parameter reference the use the `context`. **Breaking change**.
- Added support of the Grafana **Standard Options** and **Overrides** (**Units** and **Decimals**).
- Required Grafana 10 and Grafana 11. **Breaking change**.

:::info Grafana Plugins catalog
The plugin was updated in Grafana Catalog on June 6, 2024.
:::

<Shorts
src="https://www.youtube.com/embed/tdxwyaIa01Y"
title="The Business Text 5.0.0 for Grafana."
/>

## Business Text Panel

The Dynamic Text panel joins the [Business Suite](/plugins/) for Grafana and with that gets an elevated name. Now, the same amazing open source plugin is called the Business Text panel.

Please welcome the new name for the same functionality!

<Image
title="The Dynamic Text panel now is called the Business Text panel."
src="/img/blog/2024-06-19-dynamictext-panel-5.0.0/new-name.png"
/>

## Downloads

The Business Text plugin took off in May of this year and now the total downloads are close to the soaring 7,000,000!

<Image
title="Soaring 7,000,000 downloads!"
src="/img/blog/2024-06-19-dynamictext-panel-5.0.0/downloads.png"
/>

## External JavaScript replaced with Import

:::info versions
This is a breaking change. However, note, that you still can use external JavaScript code. Find details below.
:::

Since in Grafana 11, the functionality of external JavaScript resources is deprecated, we removed the **External Resource**->**Scripts** parameter. You can import the JavaScript library directly in the code.

Our documentation has [many examples](/plugins/volkovlabs-dynamictext-panel/external/) of how to use external JavaScript libraries moving forward.

## `Context` migration guide

Starting from this release, ensure to reference the Grafana parameter using the `context`

| Previously | Starting from version 5.0.0 |
| ---------------- | -------------------------------- |
| data | context.data |
| dataFrame | context.dataFrame |
| eventBus | context.grafana.eventBus |
| getLocale | context.grafana.getLocale |
| handlebars | context.handlebars |
| locationService | context.grafana.locationService |
| panelData | context.panelData |
| replaceVariables | context.grafana.replaceVariables |
| timeRange | context.grafana.timeRange |
| timezone | context.grafana.timezone |

## Standard Options and Overrides

The Grafana **Standard Options** impact all retrieved data columns, whereas **Override** allows the application of the same configuration only for a limited set of columns.

Starting from this release, the Business Text panel supports two parameters (**Units** and **Decimals**) from both **Standard Options** and **Overrides** sections.

Below is an example with various **Units** configurations.

<Image
title="Formating using Overrides."
src="/img/blog/2024-06-19-dynamictext-panel-5.0.0/units.png"
/>

Each of them is configured similarly. An example of one such configuration is below.
For simplicity, the data is specified right on the Grafana dashboard using the [Business Input data source](/plugins/volkovlabs-static-datasource/).

The numbers for configuration have a `String` type. One override is created for the `Value` column to format it using the **Newtons (N)** template.

<Image
title="Formating using Overrides in edit mode."
src="/img/blog/2024-06-19-dynamictext-panel-5.0.0/unit-edit.png"
/>

**Content** code to copy:

```js
{{!-- Return --}}
{{Text}}: {{Value}}
```

## Grafana 10 and Grafana 11

:::warning Breaking changes
Grafana 9 is not supported.
:::

Our plugins always follow the latest Grafana versions and stay compatible with the most recent releases. That means, however, that we have to sunset the support of obsolete releases.

The latest Business Text Panel 5.0.0 fully supports Grafana 10 and 11 releases.

## Getting Started

You can install Business Text Panel from the [Grafana Plugins catalog](https://grafana.com/grafana/plugins/marcusolsson-dynamictext-panel/) or using the Grafana command line tool.

For the latter, please use the following command:

```bash
grafana-cli plugins install marcusolsson-dynamictext-panel
```

## YouTube Tutorial

The Business Text panel is a mighty Grafana plugin to convert any monotonous bulk of data into vibrant, effortlessly comprehended visualization.

<Video
src="https://www.youtube.com/embed/AcQi-6GCrNU"
title="Business Text plugin for Grafana | Use HTML, Markdown, JavaScript and CSS | Community use cases."
/>

## Release Notes

### Breaking changes in 5.0.0

- Requires Grafana 10 and Grafana 11.
- Removed external scripts deprecated in Grafana 11. Use import instead.
- Removed non-context code parameters. Please update parameters to use `context`.

### Code parameters migration guide

- data -> context.data
- dataFrame -> context.dataFrame
- eventBus -> context.grafana.eventBus
- getLocale -> context.grafana.getLocale
- handlebars -> context.handlebars
- locationService -> context.grafana.locationService
- panelData -> context.panelData
- replaceVariables -> context.grafana.replaceVariables
- timeRange -> context.grafana.timeRange
- timezone -> context.grafana.timezone

### Features / Enhancements in 5.0.0

- Added plugin e2e tests and remove cypress (#301)
- Updated name to Business Text Panel (#304)
- Prepared for Grafana 11 (#304)
- Added ES6 Modules Support (#312)
- Added Units and Decimal in panel options (#311)
- Updated to Grafana 11.0 and dependencies (#315)

### Features / Enhancements in 4.5.0

- Add Info message if sanitize enabled (#290)
- Update CSS styles responsive and supporting themes (#281)
- Update to Grafana 10.4.0 (#291)

### Breaking changes in 4.4.0

- Requires Grafana 9.2 and Grafana 10

### Features / Enhancements in 4.4.0

- Update context parameter (#270)
- Added theme object, notifySuccess & notifyError (#270)
- Update dependencies and Actions (#271)
- Replace custom code parameters with Code Parameters Builder (#285)
- Update CSS class for the Panel instead of a Row (#272)
- Update Editor auto height from fixed value (#278)
- Disable unitScale and fieldMinMax standard panel options (#286)

### Bug fixes in 4.4.0

- Fix statusColor for Row (#280)

## Feedback

We're looking forward to hearing from you. You can use different ways to get in touch with us.

- Ask a question, request a new feature, or report an issue at [GitHub issues](https://github.com/volkovlabs/volkovlabs-dynamictext-panel/issues).
- Subscribe to our [YouTube Channel](https://www.youtube.com/@volkovlabs) and leave your comments.
- Sponsor our open source plugins for Grafana through [GitHub](https://github.com/sponsors/VolkovLabs).
2 changes: 1 addition & 1 deletion config/plugins_sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -289,8 +289,8 @@ const sidebars: SidebarsConfig = {
},
{
items: [
"volkovlabs-dynamictext-panel/external",
"volkovlabs-dynamictext-panel/code",
"volkovlabs-dynamictext-panel/external",
"volkovlabs-dynamictext-panel/styles",
],
label: "Rendering",
Expand Down
8 changes: 4 additions & 4 deletions docs/volkovlabs-dynamictext-panel/content.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -149,15 +149,15 @@ The first is oriented toward the general public and the second is targeted to an
### For Users

<Image
title="The Rendering Order for Users."
src="/img/blog/2023-11-21-dynamictext-panel-4.2.0/order-all.png"
title="The rendering order for users."
src="/img/plugins/volkovlabs-dynamictext-panel/order-all.png"
/>

### For Developers

<Image
title="The Rendering Order for Developers."
src="/img/blog/2023-11-21-dynamictext-panel-4.2.0/order-dev.png"
title="The rendering order for developers."
src="/img/plugins/volkovlabs-dynamictext-panel/order-dev.png"
/>

## Rendering details
Expand Down
Loading