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.
Download topic as PDF
Caution callout boxes
Use a caution callout box to provide critical information that a user can't reverse if they continue with the task.
Use caution callout boxes in the following situations:
- To warn a user of data loss
- To warn a user that an action can corrupt their data
- To let a user know that there's a consequence they can't reverse
- To tell a user to back up their data before they continue
Before using caution callout boxes, see Best practices for using callout boxes.
Example
See the following example of a caution callout box:
Always use new instances. The process of adding an instance to a search head cluster overwrites any configurations or apps currently on the instance.
Last modified on 21 November, 2023
|
PREVIOUS Note callout boxes |
NEXT Using numbers in text |
This documentation applies to the following versions of Splunk® Style Guide: current
Feedback submitted, thanks!