The home of Elastic Observability documentation.
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. |
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 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.
To build the docs:
-
Check out the
elastic/docsrepository, along with any repositories that contain source files. -
Run the
build_docsscript, passing in the path to theindex.asciidocand 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 ../apm-server/docs/guide --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.