Splunk documentation sometimes has links to pages outside of the documentation or a Splunk website. When you include a link to a page outside of a Splunk site, consider whether the link is essential for the reader or if it's supplemental information.
An essential link is a link in the documentation that brings a reader to information they might have difficulty locating on their own but need to access while reading the topic. Linking to an outside website is sometimes necessary, such as when you're sending a developer to a third-party repository or if a third-party site has information about connecting their product to a Splunk app or add-on. When you need to provide a link outside of Splunk documentation, follow these guidelines:
- Spell out the full URL.
- Include "http://www" or "https://www".
- Don't capitalize any letters in the URL.
- Remove the trailing slash at the end of the URL.
See the following examples:
- Install the fluent-plugin-systemd plugin for systemd journal log collection. See https://github.com/fluent-plugin-systemd/fluent-plugin-systemd/blob/master/README.md on GitHub.
- Create a Splunk On-Call webhook by following the steps in https://help.victorops.com/knowledge-base/rest-endpoint-integration-guide.
- You must create your own Slack app and add it to your workspace. See https://api.slack.com/messaging/webhooks in the Slack API.
Third-party links can change without your knowing, so check that the links work with every release of your documentation.
A supplemental link is a link in the documentation that brings a reader to information they can locate on their own through a simple internet search. Avoid creating deep links to pages outside of Splunk sites when the link is supplemental. Instead, consider other ways you can direct users to information if you think they need assistance finding it, such as giving the user a search term and a website name. See the following examples:
- Search for "Query tables" on the Microsoft website.
- For details, see "Connecting to WMI Remotely Starting with Vista" on the Microsoft website.
Documenting third-party products
Manual names, topic titles, and section headings
This documentation applies to the following versions of Splunk® Style Guide: current