Linking with accessibility
Ensure links in documentation are clear, descriptive, and meaningful, using exact titles or names. Avoid hiding links behind other words or actions.
Splunk docs include judicious links to supporting material and additional information. Lead into the link with a description so users can decide whether that link is useful to them.
Follow these guidelines when using links in your documentation:
- Make sure the purpose of the link is as clear, descriptive, and meaningful as possible.
- Use the exact topic title, name of the page, or name of the entity you are linking to for the link text. Don't paraphrase the linked-to topic name.
- Don't hide a link behind other words or actions in a sentence.
Review the following table for examples of linking:
| If you run Splunk apps with Splunk Enterprise, see the Splunk products version compatibility matrix to determine the versions that your apps are compatible with. | If you run Splunk apps with Splunk Enterprise, determine the versions that your apps are compatible with. |
| Use navigators and dashboards to monitor your Kubernetes cluster. See Monitor your Kubernetes cluster. | Use navigators and dashboards to monitor your Kubernetes cluster. |
For more guidance on using links in your writing, see Best practices for including links.