– Redesigned and better than ever!

Here in the Splunk documentation team, our ties to the Splunk community motivate and energize us. You keep us honest and accurate, and your ongoing feedback helps make Splunk documentation great. We couldn’t do it without you, and more important, we wouldn’t want to!

A year ago, I came to .conf with some preliminary mockups of a redesigned I talked with dozens of you, gathered your feedback, and we refined our plans so we could deliver as much of what you asked for as was humanly possible.

I am very pleased to announce that the new launches today. It incorporates both a new visual design and improved navigation. Let’s take a look.


Overall, the look and feel of the docs site now follows the design of, including a responsive layout for tablet and mobile browsers. We optimized the docs site design to support readability of more complex technical content. We carefully chose fonts, colors, and spacing to ensure that you can find and digest the information you need in order to use Splunk software.

For those of you browsing from the top level, the landing page now features:

  • A more prominent search bar.
  • Products grouped by category.
  • An incorporated @splunkdocs Twitter feed.

Most of you spend your time on the docs site reading specific topics. The redesigned topic page has numerous usability improvements:

  • You can show and hide the table of contents on the left side to adjust your reading area.
  • The topic table of contents now floats on the right side and highlights your location within the topic.
  • Code samples and notes are highlighted for better visibility.
  • Tables have contrasting row colors.


At the product level, the page also features categorized manuals for products that have complex documentation sets (like Splunk Enterprise) to create a more meaningful browsing experience.


We hope you like these changes. We have more improvements to roll out in the near future. Keep your eyes on the site, and in the coming weeks you will see:

  • A Previously Viewed topic list that shows your recent browsing history within the docs.
  • A Related Answers sidebar on the topic page, populated with search results from Splunk Answers.
  • A Popular Topics box on the manuals page for each product, to highlight our most-viewed content.
  • The ability to make a PDF of a single topic, in addition to the whole manual.
  • Enhancements to the search results pages.

We hope you like the updated site. You are seeing some great design and development work from Vincent de Witt Huberts and Ignacio Palladino on our web design team, and from Russ Uman, web developer extraordinare. You spoke, we listened, and they made it happen.

As always, we welcome your input. Please use the feedback form at the bottom of any topic to send us your comments, corrections, suggestions, and requests.

Splunk on!


Noticed the new design today for Splunk docs and would like to point out code samples such as .conf or .conf.spec files are not formatting correctly.

For example from server.conf:

# Use the [default] stanza to define any global settings.
# * You can also define global settings outside of any stanza, at the top of the file.
# * Each conf file should have at most one default stanza. If there are multiple default
# stanzas, attributes are combined. In the case of multiple definitions of the same
# attribute, the last definition in the file wins.
# * If an attribute is defined at both the global level and in a specific stanza, the
# value in the specific stanza takes precedence.

Word wrap does not appear to be working correctly as words are being truncated at the end of each line. I tested this in Chrome as well as IE.

I miss the green Splunk theme, the blue will certainly take some time getting used to!

September 18, 2015

Is there a reason you chose to put the spec files into a textbox (frame?) instead of leaving them full page? Trying to read them this morning and it’s painful.

I haven’t had a chance to get a feel for the rest of the redesign, but definitely a step in the wrong direction for the spec files

September 18, 2015

Thanks for your comments.

Noah: we are aware of the bug where spec files are truncated on some browser/OS combinations and are working on a fix.

Eric: we will try for more elegant line breaking with this preformatted text.

In both cases, while we work on these improvements, you can expand the reading area by clicking “Hide contents” at the top of the table of contents on the left. You should be able to read the spec file correctly with your view set that way.

Thanks again for your feedback!

Christopher Gales
September 18, 2015

I’m also having trouble browsing documents with large numbers of links on the right hand side. For example it is very difficult at the REST API Reference Manual for a endpoint descriptor sub page to just browse the endpoints and then click on the desired one without scrolling the entire very long page.

Colin Humphreys
September 22, 2015

Hi, Colin: Yes, we discovered this issue last week and have submitted it to our web development team. You are correct: the right-hand link lists in the REST API Reference are long enough that they don’t work with the current page behavior. We are working through how to solve the problem, and apologize for the inconvenience.

Christopher Gales
September 22, 2015

My apologies, I forgot to come back and post an update. Both these issues are fixed: we widened the reading area shortly after launch, so spec files display properly, and more recently pushed the fix for the inline table of contents (right-hand links) when those lists are very long. Thanks again for commenting!

Christopher Gales
December 15, 2015