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:
| Directory | Description |
|---|---|
| getting-started | Contains the source files for the Getting Started Guide. |
| gke-on-prem | Contains the source files for Elastic Stack and Google Cloud's Anthos |
| glossary | Contains the source files for the Elastic Glossary. |
| install-upgrade | Contains the source files for the Elastic Installation and Upgrade Guide. |
| stack/ml | Contains the source files for the Machine Learning Guide. |
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:
-
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.
-
Check out the
elastic/docsrepository and any other necessary repositories. -
Run the appropriate
build_docsscript, as listed in the doc_build_aliases.sh file.