[[beats-reference]]
= Beats Platform Reference

include::./version.asciidoc[]

include::{asciidoc-dir}/../../shared/attributes.asciidoc[]

:beatname_lc: beatname
:beatname_uc: a Beat
:beatname_pkg: {beatname_lc}
:github_repo_name: beats
:discuss_forum: beats/{beatname_lc}
:beat_default_index_prefix: {beatname_lc}
:has_ml_jobs:

include::../../libbeat/docs/shared-beats-attributes.asciidoc[]

include::./overview.asciidoc[]

include::./communitybeats.asciidoc[]

include::./gettingstarted.asciidoc[]

include::./breaking.asciidoc[]

include::./upgrading.asciidoc[]

include::./config-file-format.asciidoc[]

include::./release.asciidoc[]

include::../../libbeat/docs/contributing-to-beats.asciidoc[]
