Splunk® Style Guide

Splunk Style Guide

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Usage dictionary

The following list outlines terms to use and avoid in Splunk documentation.

*

*nix
Use to refer to both UNIX and Linux together. If only one system is supported, use "UNIX" or "Linux". See *nix in the Splexicon.

A

above
Don't use to refer to a location in a document. Directional or visual instructions are unhelpful to visually impaired users. Use "higher" to refer to versions of software.
actually
Don't use.
ad hoc
Use only when referring to an unscheduled search, otherwise don't use Latin abbreviations or terms. Don't use any other term for a search that a user launches manually. In references not about an unscheduled search, use "if needed". See ad hoc search in the Splexicon.
add-on
Include a hyphen. The plural form is "add-ons". The term takes a definite article, and you can write it as "the add-on" after the first instance of the full name of the add-on. Use the term "add-on" when you are writing about a technical add-on (TA), supported add-on (SA), or domain add-on (DA) in Splunk docs. See add-on in the Splexicon.
Correct
add-on
Add-on
the add-on
the Splunk Add-on for [name of third-party vendor]
Incorrect
add-On
Add-On
addon
AddOn
allows you to
Don't use. Use "lets you" if you're writing about the product, otherwise make the content user-focused.
AM
Write with capital letters and without periods. Use to mean between midnight and 11:59 in the morning when writing the time of day. See 12-hour clock.
and/or
Don't use. Pick the word that best fits the sentence.
anti
Don't include a hyphen.
Correct
antivirus
app
Use to refer to an application that runs on the Splunk platform. See app in the Splexicon.
at present
Don't use. Use "now".
at this point
Don't use.
auto
Don't include a hyphen.
Correct
autodiscover
autoscale
Incorrect
auto-discover
auto discover
auto-scale

B

base directories
Put the variable name for a directory in all capital letters regardless of the operating system. If the variable name has spaces, replace the spaces with the underscore ( _ ) character.
For *nix, precede the base directory with a dollar sign ( $ ). For Windows, surround the base directory with percent signs ( % ).
*nix
$SPLUNK_HOME
Windows
%SPLUNK_HOME%
basic steps
Don't use. Use "steps".
basically
Don't use.
be sure to
Don't use. Use "make sure".
below
Don't use to refer to a location in a document. Directional or visual instructions are unhelpful to visually impaired users. Use "lower" to refer to versions of software.
blacklist
Don't use. Use "deny list" as a noun and "deny" as a verb. There are additional synonyms you can use in specific situations. "Deny" refers to access, "reject" refers to validity, and "exclude" refers to inclusion. For IP traffic, for instance, "deny" is suitable. For files or rules, "exclude" might be more specific. See also whitelist.
Correct
Set up a deny list to exclude specific incoming data.
Incorrect
Blacklist the specific incoming data.

C

can not
Don't use as two words. Use "can't" or "cannot".
can't
It's okay to use simple contractions in the present tense. See Contractions.
can
Use to mean ability.
cannot
Use as one word when the emphasis is on "not". Otherwise, it's okay to use "can't". See Contractions.
case sensitive
Don't include a hyphen when you write the term after the noun that it modifies.
Correct
the password is case sensitive
Incorrect
the password is case-sensitive
case-sensitive
Include a hyphen when you write the term before the noun that it modifies.
Correct
a case-sensitive username
Incorrect
the password is case-sensitive
check box
Use as two words. Write "check or uncheck a check box", or "select or deselect a check box".
check out
Don't use. Use "see".
click
Use as the action for a button or tab. Don't use "click on".
Correct
Click OK.
Incorrect
Click on the OK button.
choose
Don't use when referring to UI selections. Use "select".
comma separated
Don't include a hyphen when you write the term after the noun that it modifies.
Correct
the list is comma separated
Incorrect
the list is comma-sensitive
comma-separated
Include a hyphen when you write the term before the noun that it modifies.
Correct
a comma-separated list
Incorrect
a comma separated list
command line
Use as two words when used as a noun.
command-line
Include a hyphen when used as an adjective.
Correct
command-line interface
command-line tool
Incorrect
command line interface
command line tool
completely
Don't use.
could
Don't use. Use "can". Avoid subjunctive mood. See Write in indicative or imperative mood.

D

DA
Domain Add-on. Don't use DA when you write about the product. Use "add-on". It's okay to use "DA" in a file or path. See add-on.
data model
Use as two words when referring to a knowledge object. See data model in the Splexicon.
data point
Use as two words.
datamodel
Use as one word when used as a search command.
dataset
Use as one word. See dataset in the Splexicon.
definitely
Don't use.
demonstrate
Don't use. Use "show" to mean illustrating or explaining with examples.
deploy
Use to mean the process of setting up the components for a partial or entire system, which can include installing and configuring software and hardware. For example, to deploy an indexer cluster means the entire process of getting the cluster up and running. This includes installing Splunk Enterprise instances and enabling them variously as the cluster manager, the peer nodes, and the search head. Similarly, to deploy a forwarder usually means to install a forwarder on an external system and configure its inputs and outputs to send data to the Splunk platform. Use "install" to mean installing a piece of software. See also install.
Correct
Deploy a multisite indexer cluster.
You can deploy forwarders in a wide variety of scenarios.
Incorrect
Install a multisite indexer cluster.
You can install forwarders in a wide variety of scenarios.
desire
Don't use. Use "want" to show hope for or to express a need.
Correct
Edit the stanzas to collect the data you want to view.
Incorrect
Edit the stanzas to collect the data you desire.
dialog box
Use as two words without "ue". Don't use "modal".
Correct
In the dialog box
Incorrect
In the dialog
In the dialogue
In the dialogue box
In the modal
dialogue
Include "ue" when referring to the conversation between two or more people.
didn't
It's okay to use simple contractions in present tense. See Contractions.
directory
See file path.
don't
It's okay to use simple contractions in present tense. See Contractions.
double-check
Don't use. Use "check" or "make sure".
double-click
Include a hyphen.
do not
Use as two word when the emphasis is on "not". Otherwise, it's okay to use "don't". See Contractions.
drag-and-drop
Use as an adjective. For a verb use "drag", which implies drop.
drill down
Use as two words as a verb.
drilldown
Use as one word without a hyphen as a noun, adjective, or interactive functionality. See drilldown in the Splexicon.
drop-down
Use only when necessary for clarity. Don't use as a noun. Include "list" with the title of the list for context.

E

earlier
Don't use to refer to versions of software. Use "lower".
e.g.
Don't use. Spell out "for example". Don't use Latin abbreviations or terms.
enables you to
Don't use. Use "lets you" if you're writing about the product, otherwise make the content user-focused.
endpoint
Use as one word.
epoch time
Don't use. Use "UNIX time".
et al.
Don't use. Use "and others". Don't use Latin abbreviations or terms.
etc.
Don't use. Use "and so on". Don't use Latin abbreviations or terms.
execute
Don't use. Use "run".

F

FAQ (Frequently Asked Questions)
Singular. Don't use "FAQs" as a plural.
fetch
Don't use. Use "retrieve".
field-value pair
Include a hyphen between "field" and "value" when they modify the word "pair".
Correct
field-value pair
Incorrect
field/value pair
field value pair
file name
Use as two words.
file name extensions
The suffix appended to a specific file type. Put in lowercase letters.
Correct
Update the stanza in indexes.conf.
Upload the upload.json file.
Enlarge the workflow.jpg image.
Create a file named tar-exmpl-2018.tar for the directory.
The manual downloads as alert_actions.pdf.
Distribute the file that ends in .splunkconfig.
Incorrect
Update the stanza in the conf file.
Upload the Upload json file.
Enlarge the workflow .jpg.
Create a compressed .tgz archive file for the directory.
The manual downloads as alert_actions.PDF.
Send the fat_cats.GIF to the entire team.
file path
A unique location in a file system. For *nix, use a forward slash ( / ). For Windows, use a backslash ( \ ).
*nix
$SPLUNK_HOME/bin/splunkd
Windows
%SPLUNK_HOME%\bin\splunkd.exe
Use angle brackets to indicate parts of a file path that differ by user or operating system, such as /home/<username>/.login. See Brackets.
file system
Use as two words.
file types
The term used for a file category, such as Portable Document Format (PDF) documents or Graphics Interchange Format (GIF) files. Use a file type when you write about a broad file category. It's okay to shorten the file type as an acronym. Capitalize the acronym when it's used as an adjective or when it stands alone in text.
Correct
The upload must be in JSON format.
Upload photos as JPG files.
Download the topic as a PDF.
Save the export as a CSV file.
The TAR file can have a .tar, .tar.gz, or .tgz extension.
Incorrect
The upload must be a .json.
Upload photos as jpegs.
Download the topic as a pdf.
Save the export as a .CSV.
The TAR file can have a TAR, .tar.GZ, or .TGZ extension.
filename
Don't use. Use "file name".
filepath
Don't use. Use "file path".
for instance
Don't use. Use "for example".

H

have been
Don't use. Use "are".
have knowledge of
Don't use. Use "know".
have plans
Don't use. Use "plan".
have the option to
Don't use. Use "can".
higher
Use to refer to versions of software. Don't use "later".
home page
Use as two words.
host name
Use as two words.
homepage
Don't use. Use "home page".
hostname
Don't use. Use "host name".
hover over
Use to describe the action of positioning the pointer over a UI item. Include the preposition "over". 

I

i.e.
Don't use. Spell out "in other words". Don't use Latin abbreviations or terms.
if you want to
Don't use in a task step. Use "(Optional)".
important
Don't use as a note tag. See Best practices for using callout boxes.
install
Use as a verb. Use to mean installing a piece of software. Use "deploy" to describe the process of setting up the components for a partial or entire system, which can include installing and configuring software and hardware. See also deploy.
Correct
Install the Splunk Enterprise .tgz file.
You can install the Splunk Add-on for Microsoft Office 365 with Splunk Web or from the command line.
Incorrect
Deploy the Splunk Enterprise .tgz file.
You can deploy the Splunk Add-on for Microsoft Office 365 with Splunk Web or from the command line.
installation
Use as a noun.
instance
Use to refer to a Splunk Enterprise instance. Use the full phrase "Splunk Enterprise instance" on the first use in the topic or section. See machine and server.
internet
Lowercase, unless it is the first word in a sentence or part of a proper noun, such as Internet Explorer. Always use with a definite article, such as "the internet".
into
Use as one word in the context of getting data into a Splunk product. Example: Get data into Splunk User Behavior Analytics.
is able to
Don't use. Use "can".
isn't
It's okay to use simple contractions in present tense. See Contractions.
it is recommended that...
Don't use. Rewrite to make a statement about what the customer must do.

J

just
Don't use.

K

key
Don't use as an adjective.
Correct
This diagram shows important components and interactions in a cluster.
Incorrect
This diagram shows the key cluster-related components and interactions.
key-value pair
Include a hyphen. Don't use a slash or space. Don't use the phrase "key value" on its own.
Correct
key-value pair
Incorrect
key value
key/value pair
keyboard characters
The core section of keys on a keyboard. Special keyboard characters, such as @, |, and / , aren't standardized on international keyboards. Be explicit when referring to special keyboard characters. See Special characters.

L

later
Don't use to refer to versions of software. Use "higher".
latest
Use to refer to the latest versions of browsers and SaaS.
launch
Don't use. Use "open" to mean starting an operation or to set in motion. It's okay to use "launch" to match the UI.
Correct
Uncheck the Launch browser with Splunk check box to prevent your browser from opening.
Incorrect
Start Splunk Enterprise and launch Splunk Web.
Place a shortcut on your desktop to launch Splunk Enterprise.
left
Don't use to refer to a location in a document. Directional or visual instructions are unhelpful to visually impaired users.
line break
A long line of code that ends on one line and continues on another line due to space limitations on an electronic or paper page. Use as two words without a hyphen. Don't refer to a forced line break as a "carriage return".
Linux
Use "Linux" if only Linux is supported. Write "*nix" when referring to both Linux and UNIX together.
log in
Use as two words as a verb. Follow with "to" to describe entering a username or password for a system. Use "as" to describe entering with a specific role or privileges. Don't use "log on".
Correct
Log in to Splunk Web.
Log in as an administrator.
Incorrect
Log on to Splunk Web.
Log on as an administrator.
log off
Don't use. Use "log out".
log on
Don't use. Use "log in".
log out
Use as a verb. Don't use "log off".
login
Use as one word as a noun or adjective. Don't use "logon".
Correct
The login interface is easy to use.
Incorrect
The logon password is "changeme".
logoff
Don't use. Use "log out".
logon
Don't use. Use "log in".
logout
Don't use as one word. Use "log out".
long press
Use to refer to the gesture used to press and hold a control on a touch-based user interface.
look up
Use as two words as a verb.
Correct
Set the CSV lookup to look up the host.
Incorrect
Set the CSV lookup to lookup the host.
lookup
Use as one word as a noun, adjective, or knowledge object. See lookup in the Splexicon.
lower
Use to refer to versions of software. Don't use "earlier".

M

machine
Use to refer to the virtual or physical machine that the instance runs on. See instance and server.
master
Don't use. Use "manager" for the centralized management, leading, or coordinating node, and when you discuss the relationship of that node with other nodes that interact with it. See manager node in the Splexicon.
Correct
License manager
Indexer cluster manager node
Incorrect
License master
Indexer cluster master node
may
Use to mean permission.
might
Use to mean possibility.
modal
Don't use. Use "dialog box".
mouse over
Don't use. Use "hover over".
multi
Don't include a hyphen.
Correct
multiserver
multisite
multivalue
Incorrect
multi-server
multi-site
multi-value
multifactor authentication
Don't use "MFA" as an abbreviation.
multivalued field
Don't use. Use "multivalue field". See multivalue field in the Splexicon.

N

non
Don't include a hyphen.
Correct
nonzero
note that
Don't use in text. Consider whether using a note callout box is more effective.
null
Write in lowercase letters to refer to an empty value, the null Search Processing Language (SPL) command, or when null appears in SPL search results.

O

on-premises
Include a hyphen and treat "premises" as plural. Don't use "on premise", "on-premise", "on prem", or "on-prem".
Correct
If your Splunk platform deployment is installed on-premises, you can...
A deployment that uses an on-premises search head...
For on-premises Splunk Enterprise instances only.
Incorrect
A deployment that uses an on-premise search head...
On-the-premises in a server room
Running Splunk Enterprise on-prem
once
Use when you mean one time and no more. Don't use to mean "after" or "when".
only
Place before or after the word or phrase it modifies.
out-of-the-box
Don't use. Use "default".

P

path name
Don't use. Use "path".
pathname
Don't use. Use "path".
per
Include a hyphen.
Correct
Per-panel
Per-result triggering
Incorrect
Per panel
Per result triggering
percent
Use a numeral followed by the percent sign ( % ) to specify an exact percentage. Don't use the word "percent".
Correct
10%
Incorrect
Ten percent
10 percent
percentage
Use as a noun when not specifying an exact quantity.
perform
Don't use in the context of searches or other commands. Use "run".
pinch
Use to refer to the two-finger gesture used to zoom out on a touch-based user interface.
please
Don't use.
plug in
Write as two words without a hyphen when you use this term as a verb.
plugin
Write as one word without a hyphen when you use this term as a noun or adjective.
plug-in
Don't use.
PM
Write with capital letters and without periods. Use to mean between noon and 11:59 in the evening when writing the time of day. See 12-hour clock.
point to
Don't use. Use "hover over".
preconfigured
Don't use. Use "configured".

Q

quite
Don't use.

R

radio button
The name of the button. Don't use "radio" without following it with a noun.
reach a decision
Don't use. Use "decide".
read/write, read/write/delete
Use the forward slash instead of a hyphen when you write about read, write, and delete permissions.
Correct
Add read/write permissions for all users.
The role restricts read/write/delete permissions.
Incorrect
Add read-write permissions for all users.
Add read and/or write permissions for all users.
real time
Use as two words when used as a noun.
Correct
Perform the search in real time.
Incorrect
Perform the search in real-time.
Perform the search in realtime.
real-time
Include a hyphen when used as an adjective.
Correct
real-time alert
real-time search
Incorrect
real time alert
realtime search
realtime
Don't use.
really
Don't use.
reboot
Don't use. Use "restart". It's okay to use "reboot" when it appears in a command.
recommend
Don't use. Rewrite to make a statement about what the customer must do.
reenable
Don't include a hyphen. Or rewrite as "enable again".
reenter
Don't include a hyphen. Or rewrite as "enter again".
refer to
Don't use. Use "see".
referred to as
Don't use. Use "called".
regex
Write out "regular expression". Don't use any other variation or abbreviation.
remember
Don't use.
rerun
Don't use. Use "run the search again". Use "again" only if it is necessary for clarity.
right
Don't use to refer to a location in a document. Directional or visual instructions are unhelpful to visually impaired users.
right-click
Include a hyphen.
run
Use in the context of searches or other commands. Don't use "execute" or "perform".
Correct
Run the search.
Incorrect
Execute the search.
Perform the search.
run time
Don't use.
run-time
Don't use.
runtime
Use as one word as a noun or adjective.

S

(s), (es)
Don't write a lowercase "s" or "es" in parentheses after a noun to indicate both singular and plural. Choose the best option for your sentence. In most cases, using the plural works best for understanding.
SA
Supporting Add-on. Don't use "SA" when you write about the product. Use "add-on". It's okay to use "SA" in a file or path. See add-on.
search
A search that a user launches manually is called an "ad hoc search". A search that runs programmatically or on a schedule is called a "scheduled search". See search in the Splexicon.
see
Use for references and cross-references. Don't use "refer to", "consult", "read", or "check out".
Example
For an introduction to forwarders, see About forwarding and receiving.
select
Use to highlight text, choose menu items, or check a check box.
server
In the Splunk platform context, the term "server" refers to an instance of the Splunk platform. Because the term "server" is used in the IT industry to refer both to a type of software and the machine that such software runs on, avoid this term. Be clear when you refer to the Splunk platform, and use one of the following terms:
instance
to refer to a Splunk platform instance
machine
to refer to the virtual or physical machine that the instance runs on
See instance and machine.
should
Don't use. Avoid subjunctive mood. See Write in indicative or imperative mood.
shows up
Don't use. Use "appears".
sign in
Don't use. See log in.
sign on
Don't use. See log in.
simply
Don't use.
slave
Don't use. Use "peer" for nodes that interact with the centralized management, leading, or coordinating node, and when you discuss the relationship among nodes that interact with these capabilities.
Correct
License peer
Indexer cluster peer node
Incorrect
License slave
source type, sourcetype
Use as one word when referring to the field name. Use as two words in all other instances. See source type in the Splexicon.
space-separated
Include a hyphen when you write the term before the noun that it modifies.
Correct
A space-separated list
Incorrect
A space separated list
specify
Don't use in steps. Use "select", "click", "type", "enter", or whatever the action is.
specifically
Don't use.
spin up, spin down
Don't use. Use "start" and "stop" or the most descriptive action for the virtual machine.
Splunk
When used alone, use "Splunk" to refer only to the company, not to any product. Don't use in the possessive form.
Correct
Splunk has a mascot called Buttercup.
a Splunk customer
Splunk.com account
Configure Splunk software
Incorrect
a Splunk account
Configure your Splunk.
Restart Splunk.
Splunk Developer Portal
Use as a proper noun to refer to https://dev.splunk.com, spelled with initial capital letters and using a definite article. Don't use abbreviations or acronyms in place of this term. Don't confuse with the Splunk Developer Program.
Correct
See the Splunk Developer Portal.
Incorrect
See Splunk Developer Portal.
See the Splunk dev portal.
See SDP.
Splunk Developer Program
Don't use in documentation. This term refers to the program containing developer offerings like services, tooling, and the Splunk Developer Portal. Don't confuse with the Splunk Developer Portal itself, which refers to https://dev.splunk.com.
Splunk Enterprise
Use to refer to the software. You can use "Splunk Enterprise" in documentation when you discuss the software. Don't include a definite article.
Correct
Splunk Enterprise
Incorrect
The Splunk Enterprise
Splunk Enterprise platform
the Splunk platform
Use to refer to any combination of Splunk Enterprise and Splunk Cloud. Include a definite article in most cases. Use as a modifier when writing about an instance, a deployment, or an environment when you're being inclusive of more than one of these platform products.
Correct
the Splunk platform
a Splunk platform instance
your Splunk platform deployment
version 7.2.4 of the Splunk platform
Incorrect
Splunk Platform
Splunk server instance
a Splunk instance
Splunk software
Use to refer to any combination of Splunk Enterprise and Splunk Cloud, any Splunk-supported apps and add-ons, or any other software produced by Splunk.
Correct
Splunk software
Incorrect
Splunk Software
Splunk Software instance
Splunk Support Portal
Use to refer to the portal where customers with a support contract can get assistance from Splunk Customer Support. Capitalize the initial letters.
Splunk Web
Use to refer to the graphical user interface for the Splunk platform. See Splunk Web in the Splexicon.
Correct
Splunk Web
Incorrect
SplunkWeb
Splunk UI
Splunk Web UI
Web UI
Web Interface
splunkd
Use when referring specifically to the Splunk Enterprise process, the service that is installed with Splunk Enterprise on Windows machines, or a service used to manage the splunkd process on Linux machines. Don't use in place of Splunk Enterprise or the Splunk platform. See splunkd in the Splexicon.
Correct
Splunk Enterprise installs a process called splunkd on your host.
Configure systemd to manage splunkd as a service.
Incorrect
After installing the add-on, restart splunkd.
spread
Use to refer to the two-finger gesture used to zoom in on a touch-based user interface.
SSH
Don't use as a verb.
Correct
Log into the instance using SSH.
Use Secure Shell (SSH) to log into the instance.
Incorrect
SSH into the instance.
switch or switch component
A clickable slider bar in the UI that switches back and forth between on and off states. It's okay to say "switch", "switch component", or "toggle switch". Don't call a switch a "toggle."
symbol
See keyboard character.

T

takes you to
Don't use. Use "open".
TA
Technology Add-on. Don't use "TA" when you write about the product. Use "add-on". It is okay to use "TA" in a file or path. See add-on.
tap
Use to refer to the gesture used to press or select a control or link on a touch-based user interface.
tarball
Don't use. Use "TAR file".
The purpose of this document is...
Don't use. Rewrite to be user-focused.
This document describes...
Don't use. Rewrite to be user-focused.
This topic describes...
Don't use. Rewrite to be user-focused.
thus
Don't use.
time series
Use as two words when used as a noun. See time series in the Splexicon.
time-series
Include a hyphen when used as an adjective.
timeseries
Don't use. Use "time series" as a noun or "time-series" as an adjective.
toggle
Use as a verb to click a switch component back and forth between on and off states. Don't call a switch component a "toggle."
toggle switch
A clickable slider bar in the UI that switches back and forth between on and off states. It's okay to say "switch", "switch component", or "toggle switch". Don't call a toggle switch a "toggle."
totally
Don't use.

U

UNIX
Use "UNIX" if only UNIX is supported. Write "*nix" when referring to both UNIX and Linux together.
UNIX time
Use instead of "epoch time".
URI, URL
Use "URI" or "URL" when referring to the respective string type. Choose the most specific initialism for your scenario. See also URN.
URN
Don't use. Use "URI" instead.
username
Use as one word in written text. If "user name" appears as two words in the UI, write "user name" as two words in the documentation to match.
utilize
Don't use. Use "use".

V

v
Spell out "version" instead of abbreviating with a "v".
Correct
Splunk platform versions 6.6.x and 7.0.x
very
Don't use.
vetted
Don't use. Use "approved".
via
Don't use. Use "by using" or "through". Don't use Latin abbreviations or terms.
vice versa
Don't use. Use "and the reverse". Don't use Latin abbreviations or terms.
view
Use when describing the UI. Don't use "see".
Correct
This charts lets you view the percentage of crashes.
View app usage.
visit
Don't use in the context of Internet sites. Use "go to", "navigate to", or another phrase.
vs.
Don't use. Spell out "versus". Don't use Latin abbreviations or terms.

W

warning
Don't use as a note type. A warning indicates danger or bodily harm and appears in hardware documentation.
web
Lowercase unless it is part of a proper name, like Splunk Web or World Wide Web.
whether or not
Don't use. Use "whether".
whitelist
Don't use. Use "allow list" as a noun and "allow" or "include" as a verb. For a single item, use "allow rule" or "allow entry". There are additional synonyms you can use in specific situations. "Allow" refers to access, "accept" refers to validity, and "include" refers to inclusion. For IP traffic, for instance, "allow" is suitable. For files or rules, "include" might be more specific. See also blacklist.
Correct
Set up an allow list to include specific incoming data.
Incorrect
Whitelist the specific incoming data.
wish
Don't use. Use "want".
won't
Don't use. Avoid contractions in the future tense. See Contractions.
would
Don't use. Avoid subjunctive mood. See Write in indicative or imperative mood.

X

x (version number in releases)
Use a lowercase "x" at the relevant place in the version name when referring to maintenance builds, minor versions, or releases for a product. Don't include a "v" for version before the number.
Correct
Splunk Enterprise 7.x
Splunk platform versions 6.6.x and 7.0.x
Incorrect
Splunk platform v5.0.x
Splunk platform version 7.1.X
Last modified on 04 December, 2020
PREVIOUS
A word about Splunk docs
  NEXT
Tone

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


Was this documentation topic helpful?

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