Splunk® Style Guide

Splunk Style Guide

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.

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.


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
Note callout boxes   Using numbers in text

This documentation applies to the following versions of Splunk® Style Guide: current

Was this topic useful?

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters