Skip to content

Commit 7820cca

Browse files
authored
Specifying allowed alert types (#1063)
* Specifying allowed alert types Signed-off-by: Dominika Schweier <dominika.schweier@nokia.com> * Copilot correction Signed-off-by: Dominika Schweier <dominika.schweier@nokia.com> --------- Signed-off-by: Dominika Schweier <dominika.schweier@nokia.com>
1 parent 24020b6 commit 7820cca

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

  • docs/content/en/docs/12_contributing/docs-contribution

docs/content/en/docs/12_contributing/docs-contribution/_index.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,16 @@ See [Package Lifecycle]({{%/* relref "package-lifecycle" */%}}).
150150
[Kubernetes documentation](https://kubernetes.io/docs/)
151151
```
152152

153-
**Alerts (info/warning boxes)**: Use [Docsy alert shortcodes](https://www.docsy.dev/docs/content/shortcodes/#alert)
153+
**Alerts (note/warning/critical boxes)**: There are three alert types available based on the importance of the information:
154+
155+
| Alert type | Code | Alert color |
156+
|------------|-------------------|-------------|
157+
| Note | `color="primary"` | Blue |
158+
| Warning | `color="warning"` | Yellow |
159+
| Critical | `color="danger"` | Red |
160+
161+
Make sure not to change the title of the alert type. It should always be either Note, Warning or Critical.
162+
154163
```markdown
155164
{{%/* alert title="Note" color="primary" */%}}
156165
Important information here.

0 commit comments

Comments
 (0)