kdelemme / observability-docs

Elastic Observability Documentation

observability-docs

The home of Elastic Observability documentation.

Directories

Within this repo, the /docs/en/ directory is structured as follows:

Directory	Description
integrations	Contains the source files for the Integrations Developer Guide
observability	Contains the source files for the Observability Guide, which includes content for APM, Logs, Metrics, Synthetics, User experience, and Uptime.
shared	Contains the source files for shared Observability content.
templates	Contains content templates.

Reviews

All documentation pull requests automatically add the @obs-docs team as a reviewer.

Backporting

Pull requests should be tagged with the target version of the Elastic Stack along with any relevant backport labels. In general, we only backport documentation changes to live stack versions. For manual backports, we recommend using the backport tool to easily open backport PRs. If you need help, ping @obs-docs and we'd be happy to handle the backport process for you.

Build

To build the docs:

1. Check out the elastic/docs repository, along with any repositories that contain source files.

2. Run the build_docs script, passing in the path to the index.asciidoc and resource paths to other repos that contain source files. For example, to build the Observability Guide and open it in the browser, run:

../docs/build_docs --doc ./docs/en/observability/index.asciidoc --chunk 3 --resource ../apm-server --resource ../ingest-docs/docs --open

The above command assumes that elastic/docs, elastic/beats, and elastic/apm-server are checked out into the same parent directory.

If you prefer to use aliases, you can load the elastic/docs/doc_build_aliases.sh file, which has the resources defined for you.