This repository contains the code and documentation for https://docs.splunk.com/Observability

A private mirror exists where the Splunk technical writers edit documentation for new and updated features. The public and the private repositories update each other automatically using repo-sync.

Docs contributions are welcome. See CONTRIBUTING.md for the contribution guidelines.

The documentation is built from reStructuredText and Markdown files using Sphinx.

To contribute to the documentation you need a GitHub account. See CONTRIBUTING.md for our contribution guidelines.

To build the documentation on your machine use the Docker container in this repository, which provides a configured Python environment. To run the container you need Docker Desktop or a compatible container runtime.

Follow these steps to fork this repo and install it on your machine:

1. Clone this repository using git clone.
2. Navigate to the cloned repository in your file system.
3. Change the permissions of start.sh by entering chmod +x start.sh in the terminal.

This Splunk repository is subject to the Splunk Websites Terms and Conditions of Use ("Terms") https://www.splunk.com/en_us/legal/terms/terms-of-use.html and the LICENSE specific to this repository.

You can contribute new documentation and edits to the existing documentation.