Splunk® Style Guide

Splunk Style Guide

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Links to Splunk materials

Use a hyperlink to cross-reference other topics in Splunk documentation or to connect to other Splunk materials, such as Splunk Blogs posts or Splunk Answers. When linking to Splunk materials in text, follow these formatting rules:

  • Build the link into its own standalone sentence. Don't make the hyperlink a word or phrase that is part of the meaning of the sentence.
  • Use the word "See" to introduce a link in the sentence or clause.
  • Use the full topic title or section heading as the display name for the link. Don't paraphrase the linked-to topic name.
  • Use italics for the manual name if you are linking to a topic in another manual.
  • Keep punctuation that isn't part of the title outside of the link.
Correct
To add additional roles, you can create custom roles. See Create a custom role.
Incorrect
To add additional roles, you can create custom roles.

When linking to Splunk materials, format the links according to this table:

When linking to this type of material Include this information in the link Example
A product Link to the documentation home page for that product. For information about Splunk Enterprise, see the Splunk Enterprise documentation.
A manual Link to the first topic of the manual. Use the manual name as the display name for the link. Italicize the manual name. To learn about getting data into Splunk Enterprise, see Getting Data In.
A chapter Link to the first topic in the chapter. Use the name of the chapter as the display name for the link. To learn about configuring timestamps, see Configure timestamps.
A topic or subheading in a topic in the same manual

When linking to a topic or subheading in a topic that's in the same manual, use the full topic name. Don't include the name of the manual.

See Create a custom role or Clone a custom role in this topic.

See Get Windows Data into Splunk Cloud.

A topic or subheading in a topic in a different manual

When linking to a topic or subheading in a topic in a different manual that's in the same product, include the manual name in italics.

See About data models in the Knowledge Manager Manual.

See Configure workload categories in the Splunk Enterprise Workload Management manual.

A topic or subheading in a topic in a different product

When linking to a topic or subheading in a topic in a manual that's in a different product, include the product name before the manual name. However, if the manual name refers to the product name, don't include the product name. Italicize the manual name.

See Modify event processing in the Splunk Cloud Getting Data In manual.

See About the Splunk App for CEF in the Deploy and Use Splunk App for CEF manual.

Splunk Cloud and Splunk Enterprise manuals from app documentation When the target of a link is different for Splunk Cloud and Splunk Enterprise, display the links for both products in a bulleted list.
A Splunk resource Name the Splunk resource so the reader knows where the link is taking them. Use the name of the page or item as the display name of the link.

Download the Splunk Add-on for Microsoft Cloud Services from Splunkbase.

Download the Splunk Universal Forwarder for your operating system from the Splunk website.

See Develop apps and add-ons for Splunk Enterprise on the Splunk Developer Portal.

See Metrics and Metadata in the SignalFx documentation.

See the Splunk Blogs post Data Sherlock: The Change of Perspective.

See Questions related to Splunk Add-on for Amazon Web Services on Splunk Answers.

To file a ticket on the Splunk Support Portal, see Support and Services.

Last modified on 09 December, 2020
PREVIOUS
Links for Splexicon entries and download files
  NEXT
Links to third-party websites

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