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.

Versions

When writing about versions of software, follow these guidelines.

Numbers associated with software versions

Use numerals when writing version numbers.

You can include the word "version" before the number or choose to leave it off as long as it doesn't cause confusion. Don't substitute "v" for version before the number. See the following examples:

  • Splunk Enterprise 9.1.2
  • Splunk Distribution of OpenTelemetry JS version 2.0
  • Parquet-mr API version 1.11.1

When referencing maintenance builds, minor versions, or releases for a product, use a lowercase "x" at the relevant place in the version name to indicate the entire range. See the following examples:

  • Splunk Enterprise 8.x
  • Splunk platform versions 8.2.x and 9.0.x

Referring to versions of software

Use "higher" or "lower" when referring to versions of software. Don't use "earlier" or "later". See the following examples:

  • Install version 4.0.0 or higher of the Python for Scientific Computing (PSC) add-on from Splunkbase.
  • If your Splunk OTel Collector version is lower than 0.44.0, check your configuration.
  • AlwaysOn Profiling requires .NET 6.0 or higher.
Last modified on 11 January, 2024
Time   Show symbols in text

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

Acrobat logo Download manual
Acrobat logo Download this page

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