The Beats documentation follows the tagging guidelines described in the Docs HOWTO. However it extends these capabilities in a couple ways:
- The documentation makes extensive use of AsciiDoc conditionals to provide content that is reused across multiple books. This means that there might not be a single source file for each published HTML page. Some files are shared across multiple books, either as complete pages or snippets. For more details, refer to Where to find the Beats docs source.
The documentation includes some files that are generated from YAML source or
pieced together from content that lives in
_metadirectories under the code (for example, the module and exported fields documentation). For more details, refer to Generated docs.
Where to find the Beats docs sourceedit
Because the Beats documentation makes use of shared content, doc generation scripts, and componentization, the source files are located in several places:
|Location of source files
Main docs for the Beat, including index files
Shared docs and Beats Platform Reference
The conf.yaml file in the
docs repo shows all the resources used to build each book. This file is used
to drive the classic docs build and is the source of truth for file locations.
If you can’t find the source for a page you want to update, go to the published page at www.elastic.co and click the Edit link to navigate to the source.
The Beats documentation build also has dependencies on the following files in the docs repo:
docs.asciidoc files in
_meta directories, you must run the
doc collector scripts to regenerate the docs.
Make sure you
set up your Beats development environment and use
the correct Go version. The Go version is listed in the
for the branch you want to update.
To run the docs collector scripts, change to the beats directory and run:
make update command overwrites files in the
without warning. If you accidentally update a generated file and run
make update, your changes will be overwritten.
To format your files, you might also need to run this command:
The make command calls the following scripts to generate the docs: