diff --git a/contribute/style-guides/documentation-style-guide.md b/contribute/style-guides/documentation-style-guide.md index 6a5b71b86af..20e105893b0 100644 --- a/contribute/style-guides/documentation-style-guide.md +++ b/contribute/style-guides/documentation-style-guide.md @@ -115,6 +115,36 @@ When possible, use the exact title of the page or section you are linking to as **Example** Refer to the [Documentation style guide](documentation-style-guide.md) for information about word usage and capitalization guidelines. +### Notes, tips, cautions, and warnings + +Grafana documentation uses notes, tips, cautions, and warnings. Notes are the most common. The format for all of them is indented, bold, sentence case: + +``` +> **Note:** +``` + +#### Notes + +Notes provide additional information that the user should be extra aware of. For example: + +> **Note:** This page describes a feature for Grafana 7.0 beta. + +#### Tips + +Tips describe alternate or more efficient ways of doing things. Rarely used. + +#### Cautions + +Cautions warn the user that they should proceed with caution. Use cautions to emphasize the potential downside of a course of action. + +> **Caution:** If you turn off authentication requirements, then anyone can access your Grafana instance. This poses a considerable security risk. + +#### Warnings + +Warnings tell the user not to do something. For example: + +> **Warning:** Grafana does not back up your dashboards. If you delete a dashboard, then you might not be able to recover it. + ### Command line examples * Do not assume everyone is using Linux. Make sure instructions include enough information for Windows and Mac users to successfully complete procedures.