Splunk® Style Guide

Splunk Style Guide

Acrobat logo Download manual as PDF

Acrobat logo Download topic as PDF

Links for Splexicon entries and download files

You can include links to Splexicon entries and download files as part of your sentence. You don't need to use a "See" reference to introduce the link.

Splexicon entries

Links to Splexicon entries help familiarize users with Splunk-specific terms. Link only to terms that your audience might be unfamiliar with, and include the link at the first instance of the term you want to define. Bold the Splexicon term. See the following examples:

  • You must configure the receiving port on the peer.
  • The universal forwarder collects data from a data source or another forwarder and sends it to a different forwarder or a deployment.

Download files

When you link to a downloadable file, use the file name or document name as the display name of the link. See the following examples:

Last modified on 29 October, 2019
Best practices for including links
Links to Splunk materials

This documentation applies to the following versions of Splunk® Style Guide: 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