grafana / grafana/alerting

Bold and italic formatting for notifications

Open
#373 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
Go
Stars
89
Forks
74
Avg merge
2d 7h
Merged PRs (30d)
8

Description

On https://grafana.com/docs/grafana/latest/alerting/configure-notifications/template-notifications/ , it says that with a notification template you can:
```
Format text with bold and italic styles, and add or remove line breaks.
```

If this is possible, please document **how** to do it.

Or, if it is not possible, I guess the documentation should say something like "you can not use any HTML or Markdown formatting, only plain text will be rendered".

I notice that the default template rendered for email does have some formatting.

Background: I'm trying to create an email notification, and am wondering how I can format the text. These would be nice, if available:
* bold
* italic
* HTML link with title, e.g. `[Link title](URL)`
* bullet point lists
* "code" blocks, like:
```
foo
bar
baz
```

I blindly tried things like `**stars for bold text**` or `bold text with html tag`, to no avail.

Contributor guide

Open the contributing guide

Research direction

Start with the notification template documentation at the linked Grafana page and compare its formatting claims with the default email template rendering. Determine which bold, italic, link, list, code-block, and line-break forms are supported, then update the documentation with the syntax or clearly state that only plain text is rendered.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.