# stack-docs

**Repository Path**: mirrors_elastic/stack-docs

## Basic Information

- **Project Name**: stack-docs
- **Description**: Elastic Stack Documentation
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-01-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# stack-docs

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

## Directories

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

| Directory             | Description |
| --------------------- | ----------- |
| __getting-started__ | Contains the source files for the [Getting Started Guide](https://www.elastic.co/guide/en/elastic-stack-get-started/current/index.html).|
| __gke-on-prem__      | Contains the source files for [Elastic Stack and Google Cloud's Anthos](https://www.elastic.co/guide/en/integrations-developer/current/index.html)
| __glossary__     | Contains the source files for the [Elastic Glossary](https://www.elastic.co/guide/en/elastic-stack-glossary/current/index.html).|
| __install-upgrade__ | Contains the source files for the [Elastic Installation and Upgrade Guide](https://www.elastic.co/guide/en/elastic-stack/current/index.html).|
| __stack/ml__ | Contains the source files for the [Machine Learning Guide](https://www.elastic.co/guide/en/machine-learning/current/index.html).|

## Backporting

In general, we backport documentation changes only to [live stack versions](https://github.com/elastic/docs/blob/master/conf.yaml#L74).

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](https://github.com/sqren/backport) to easily open backport PRs. If you need help, ping __[@mlr-docs](https://github.com/orgs/elastic/teams/mlr-docs)__ and we'd be happy to help.

## Build

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](https://github.com/elastic/docs/blob/master/conf.yaml) or the [doc_build_aliases.sh file](https://github.com/elastic/docs/blob/master/doc_build_aliases.sh).

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](https://github.com/elastic/docs/blob/master/doc_build_aliases.sh).

## License

Shield: [![CC BY-NC-ND 4.0][cc-by-nc-nd-shield]][cc-by-nc-nd]

This work is licensed under a
[Creative Commons Attribution-NonCommercial-NoDerivs 4.0 International License][cc-by-nc-nd].

[![CC BY-NC-ND 4.0][cc-by-nc-nd-image]][cc-by-nc-nd]

[cc-by-nc-nd]: http://creativecommons.org/licenses/by-nc-nd/4.0/
[cc-by-nc-nd-image]: https://licensebuttons.net/l/by-nc-nd/4.0/88x31.png
[cc-by-nc-nd-shield]: https://img.shields.io/badge/License-CC%20BY--NC--ND%204.0-lightgrey.svg