elastic / elastic/docs-content

Docs fix — applies_to: path /deploy-manage/production-guidance — 15 pages

Open
#7,586 0 comments 0 reactions 0 assignees View on GitHub
docs-fix:applies-to docs-fix:applies-to] docs-quality-sweep
Dominant language
No language data
Stars
47
Forks
261
Avg merge
3d 12h
Merged PRs (30d)
116

Description

Generated by `gh-aw-docs-applies-to-sweep` for `elastic/docs-content` on 2026-W31.

Path /deploy-manage/production-guidance · 20 total in scope · subtree corpus 20 pages.

## Findings (15)

All findings share the same root cause: the page-level `applies_to.deployment` block uses the deprecated key `ess` instead of the current key `ech` (Elastic Cloud Hosted). Verified against the published reference (`/docs/contribute-docs/how-to/cumulative-docs/reference`, key list: `ece`, `eck`, `self`, `ech`) and the repo's local `contribute-docs/_snippets/applies_to-key.md`, neither of which lists `ess` as a valid `deployment` subkey.

```yaml
- file: deploy-manage/production-guidance/availability-and-resilience.md
line: 7
category: outdated-applies-to
severity: high
confidence: high
evidence: "applies_to.deployment.ess is not a recognized deployment key; the current key for Elastic Cloud Hosted is `ech`"
suggested_fix: |
applies_to:
deployment:
ech: all
ece: all
eck: all
self: all
- file: deploy-manage/production-guidance/availability-and-resilience/resilience-in-ech.md
line: 5
category: outdated-applies-to
severity: high
confidence: high
evidence: "applies_to.deployment.ess is not a recognized deployment key; the current key for Elastic Cloud Hosted is `ech`"
suggested_fix: |
applies_to:
deployment:
ech: all
ece: all
- file: deploy-manage/production-guidance/elasticsearch-in-production-environments.md
line: 8
category: outdated-applies-to
severity: high
confidence: high
evidence: "applies_to.deployment.ess is not a recognized deployment key; the current key for Elastic Cloud Hosted is `ech`"
suggested_fix: |
applies_to:
deployment:
ech: all
ece: all
eck: all
self: all
- file: deploy-manage/production-guidance/general-recommendations.md
line: 6
category: outdated-applies-to
severity: high
confidence: high
evidence: "applies_to.deployment.ess is not a recognized deployment key; the current key for Elastic Cloud Hosted is `ech`"
suggested_fix: |
applies_to:
deployment:
ech: all
ece: all
eck: all
self: all
- file: deploy-manage/production-guidance/kibana-alerting-production-considerations.md
line: 7
category: outdated-applies-to
severity: high
confidence: high
evidence: "applies_to.deployment.ess is not a recognized deployment key; the current key for Elastic Cloud Hosted is `ech`"
suggested_fix: |
applies_to:
deployment:
ech: all
ece: all
eck: all
self: all
- file: deploy-manage/production-guidance/kibana-in-production-environments.md
line: 5
category: outdated-applies-to
severity: high
confidence: high
evidence: "applies_to.deployment.ess is not a recognized deployment key; the current key for Elastic Cloud Hosted is `ech`"
suggested_fix: |
applies_to:
deployment:
ech: all
ece: all
eck: all
self: all
- file: deploy-manage/production-guidance/kibana-task-manager-scaling-considerations.md
line: 7
category: outdated-applies-to
severity: high
confidence: high
evidence: "applies_to.deployment.ess is not a recognized deployment key; the current key for Elastic Cloud Hosted is `ech`"
suggested_fix: |
applies_to:
deployment:
ech: all
ece: all
eck: all
self: all
- file: deploy-manage/production-guidance/kibana-traffic-scaling-considerations.md
line: 7
category: outdated-applies-to
severity: high
confidence: high
evidence: "applies_to.deployment.ess is not a recognized deployment key; the current key for Elastic Cloud Hosted is `ech`"
suggested_fix: |
applies_to:
deployment:
ech: all
ece: all
eck: all
self: all
- file: deploy-manage/production-guidance/optimize-performance.md
line: 7
category: outdated-applies-to
severity: high
confidence: high
evidence: "applies_to.deployment.ess is not a recognized deployment key; the current key for Elastic Cloud Hosted is `ech`"
suggested_fix: |
applies_to:
deployment:
ech: all
ece: all
eck: all
self: all
- file: deploy-manage/production-guidance/optimize-performance/approximate-knn-search.md
line: 6
category: outdated-applies-to
severity: high
confidence: high
evidence: "applies_to.deployment.ess is not a recognized deployment key; the current key for Elastic Cloud Hosted is `ech`"
suggested_fix: |
applies_to:
deployment:
ech: all
ece: all
eck: all
self: all
- file: deploy-manage/production-guidance/optimize-performance/disk-usage.md
line: 6
category: outdated-applies-to
severity: high
confidence: high
evidence: "applies_to.deployment.ess is not a recognized deployment key; the current key for Elastic Cloud Hosted is `ech`"
suggested_fix: |
applies_to:
deployment:
ech: all
ece: all
eck: all
self: all
- file: deploy-manage/production-guidance/optimize-performance/indexing-speed.md
line: 6
category: outdated-applies-to
severity: high
confidence: high
evidence: "applies_to.deployment.ess is not a recognized deployment key; the current key for Elastic Cloud Hosted is `ech`"
suggested_fix: |
applies_to:
deployment:
ech: all
ece: all
eck: all
self: all
- file: deploy-manage/production-guidance/optimize-performance/search-speed.md
line: 6
category: outdated-applies-to
severity: high
confidence: high
evidence: "applies_to.deployment.ess is not a recognized deployment key; the current key for Elastic Cloud Hosted is `ech`"
suggested_fix: |
applies_to:
deployment:
ech: all
ece: all
eck: all
self: all
- file: deploy-manage/production-guidance/optimize-performance/size-shards.md
line: 6
category: outdated-applies-to
severity: high
confidence: high
evidence: "applies_to.deployment.ess is not a recognized deployment key; the current key for Elastic Cloud Hosted is `ech`"
suggested_fix: |
applies_to:
deployment:
ech: all
ece: all
eck: all
self: all
- file: deploy-manage/production-guidance/scaling-considerations.md
line: 6
category: outdated-applies-to
severity: high
confidence: high
evidence: "applies_to.deployment.ess is not a recognized deployment key; the current key for Elastic Cloud Hosted is `ech`"
suggested_fix: |
applies_to:
deployment:
eck: all
ech: all
ece: all
self: all
```

## Done when
- All 15 listed pages use `ech` (not `ess`) as the deployment key for Elastic Cloud Hosted in their `applies_to` frontmatter.
- A PR addressing this issue is merged.

## Notes
- The remaining 5 in-scope pages (`availability-and-resilience/resilience-in-larger-clusters.md`, `availability-and-resilience/resilience-in-small-clusters.md`, `kibana-configure-memory.md`, `kibana-load-balance-traffic.md`, `kibana-reporting-production-considerations.md`) already use only valid deployment keys (`self`, `eck`) and were not flagged.
- The `all` value used throughout (e.g., `ech: all`) is a repo-wide convention outside this sweep's verified lifecycle vocabulary (`experimental`, `preview`, `ga`, `deprecated`, `removed`, `unavailable`); it was not flagged here because it is used consistently across hundreds of files in the repo and changing it would require a broader repo-wide decision, not a per-page fix.

> Generated by [Docs `applies_to` sweep agent](https://github.com/elastic/docs-content/actions/runs/30255955760) · sonnet50 56 AIC · ⌖ 5.04 AIC · ⊞ 11.8K · [◷](https://github.com/search?q=repo%3Aelastic%2Fdocs-content+is%3Aissue+%22gh-aw-workflow-call-id%3A+elastic%2Fdocs-content%2Fgh-aw-docs-applies-to-sweep%22&type=issues)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the 15 files listed under deploy-manage/production-guidance and inspect their applies_to frontmatter. Compare the deployment keys with contribute-docs/_snippets/applies_to-key.md, then update only the deprecated key identified in each finding. The work is done when all 15 pages use ech instead of ess and the repository checks pass.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
Half a day
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.