The home of Elastic Observability documentation.
Within this repo, the /docs/en/ directory is structured as follows:
| Directory | Description |
|---|---|
| observability | Contains the source files for the Observability Guide, which includes content for APM, Logs, Metrics, Synthetics, User experience, and Uptime. |
| ingest-management | Contains the source files for the Fleet User Guide. |
| shared | Contains the source files for shared Observability content. |
| templates | Contains content templates. |
All documentation pull requests automatically add the @obs-docs team as a reviewer.
Pull requests should be tagged with the target version of the Elastic Stack. In general, we only backport documentation changes to live stack versions.
After your PR is merged, we recommend using the backport tool to easily open backport PRs:
backport. Alternatively, ping @obs-docs and we'd be happy to handle the backport process for you.
To build the docs:
. Check out the elastic/docs repository, along with any repositories that contain source files.
. 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 1 --resource ../beats/libbeat/docs --resource ../apm-server/docs/guide --open
The above command assumes that elastic/docs, elastic/beats and elastic/apm-server are checked out into the same parent directory.