This repository is the home for the cross-stack (Elastic Stack) documentation, such as the Installation and Configuration Guide and the Machine Learning Guide.

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

In general, we backport documentation changes only to live stack versions.

To automatically create backport PRs, add the appropriate backport labels (such as backport-8.1).

If no backport PRs are required or you want to backport manually, add the backport-skip label. We recommend using the backport tool to easily open backport PRs. If you need help, ping @mlr-docs and we'd be happy to help.

To build the docs:

1. Identify which book you want to build and whether it has any dependencies on other repositories. You can see the required repositories for each book in either the conf.yaml or the doc_build_aliases.sh file.

2. Check out the elastic/docs repository and any other necessary repositories.

3. Run the appropriate build_docs script, as listed in the doc_build_aliases.sh file.