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.


You can use prepositions to orient users to a location when writing Splunk documentation. Use your best judgment to determine what sounds best.

Choosing the best preposition

Use "into" in the context of getting data into a Splunk product. Otherwise, choose any preposition that fits the context of the sentence and doesn't cause confusion for the reader. The following list shows a number of acceptable options:

from the command line
from the Settings menu
in Splunk Cloud Platform
in a folder
in the Search bar
Get data into Splunk Enterprise.
on a forwarder
on an indexer
on the Dashboard toolbar
on your web browser
within a multi-clustered environment

You can also choose another word, such as "over", "across", "through", or "with" if that is more accurate:

  • over large datasets
  • across your deployment servers
  • through a custom event
  • with a token

Avoid Latin phrases in Splunk documentation, so don't use "via" as a preposition. See American English spelling and phrases.

Placing prepositions in a sentence

Place the preposition where it makes the sentence easiest to comprehend. It's okay to use a preposition at the end of a sentence. See the following examples:

  • Determine which deployment you're running your app in.
  • Define the assets that admins interact with.
  • This field represents the protocol that the rule is written for.
Last modified on 08 December, 2023
Possessive names and terms   Pronouns

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