The guidelines in the Splunk Style Guide establish best practices for writing technical documentation. Search docs.splunk.com to find documentation related to Splunk products.
Note callout boxes
Use a note callout box to provide an important piece of information or a tip that isn't an integral part of the content but that adds clarity or more information.
Use note callout boxes in the following situations:
- To supplement a point in the main text
- To supply information that applies in special cases
- To suggest alternative methods
Before using note callout boxes, see Best practices for using callout boxes.
Example
See the following example of a note callout box:
If you have a Splunk Enterprise high-availability deployment, use per-result triggering carefully. If a peer is not available, a real-time search won't warn you that the search might be incomplete. To avoid this issue, use a scheduled alert instead.
Last modified on 21 November, 2023
| Best practices for using callout boxes | Caution callout boxes |
This documentation applies to the following versions of Splunk® Style Guide: current
Download manual
Feedback submitted, thanks!