elastic / elastic/docs-content

Docs fix — style: path /deploy-manage/production-guidance — 92 pages

Open
#7,587 0 comments 0 reactions 0 assignees View on GitHub
docs-fix:style 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-style-sweep` for `elastic/docs-content` on 2026-W31.

Full sweep of deploy-manage/production-guidance · 20 total in scope · corpus 20 pages.

## Findings (92)

```yaml
- file: deploy-manage/production-guidance/availability-and-resilience.md
line: 53
category: word-choice
severity: low
confidence: high
evidence: "in order to — Elastic.Wordiness: Consider using 'to' instead of 'in order to'."
suggested_fix: |
to
- file: deploy-manage/production-guidance/availability-and-resilience.md
line: 56
category: word-choice
severity: low
confidence: high
evidence: "has the capacity to — Elastic.Wordiness: Consider using 'can' instead of 'has the capacity to'."
suggested_fix: |
can
- file: deploy-manage/production-guidance/availability-and-resilience.md
line: 59
category: word-choice
severity: low
confidence: high
evidence: "in between — Elastic.Wordiness: Consider using 'between' instead of 'in between'."
suggested_fix: |
between
- file: deploy-manage/production-guidance/availability-and-resilience.md
line: 66
category: word-choice
severity: low
confidence: high
evidence: "In addition — Elastic.Wordiness: Consider using 'also' instead of 'In addition'."
suggested_fix: |
also
- file: deploy-manage/production-guidance/availability-and-resilience/resilience-in-larger-clusters.md
line: 31
category: word-choice
severity: low
confidence: high
evidence: "In addition — Elastic.Wordiness: Consider using 'also' instead of 'In addition'."
suggested_fix: |
also
- file: deploy-manage/production-guidance/availability-and-resilience/resilience-in-larger-clusters.md
line: 39
category: word-choice
severity: low
confidence: high
evidence: "in order to — Elastic.Wordiness: Consider using 'to' instead of 'in order to'."
suggested_fix: |
to
- file: deploy-manage/production-guidance/availability-and-resilience/resilience-in-larger-clusters.md
line: 43
category: word-choice
severity: low
confidence: high
evidence: "all of — Elastic.Wordiness: Consider using 'all' instead of 'all of '."
suggested_fix: |
all
- file: deploy-manage/production-guidance/availability-and-resilience/resilience-in-small-clusters.md
line: 70
category: word-choice
severity: low
confidence: high
evidence: "etc — Elastic.Latinisms: Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'."
suggested_fix: |
and so on
- file: deploy-manage/production-guidance/kibana-alerting-production-considerations.md
line: 15
category: formatting
severity: low
confidence: high
evidence: ": p — Elastic.HeadingColons: Capitalize ': p'."
suggested_fix: |
Capitalize the word after the colon in the heading.
- file: deploy-manage/production-guidance/kibana-alerting-production-considerations.md
line: 47
category: word-choice
severity: low
confidence: high
evidence: "a large number of — Elastic.Wordiness: Consider using 'many' instead of 'a large number of'."
suggested_fix: |
many
- file: deploy-manage/production-guidance/kibana-reporting-production-considerations.md
line: 30
category: word-choice
severity: low
confidence: high
evidence: "and newer — Elastic.Versions: Use 'and later' instead of 'and newer' when referring to versions."
suggested_fix: |
and later
- file: deploy-manage/production-guidance/kibana-reporting-production-considerations.md
line: 44
category: word-choice
severity: low
confidence: high
evidence: "e.g — Elastic.Latinisms: Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'."
suggested_fix: |
for example
- file: deploy-manage/production-guidance/kibana-task-manager-scaling-considerations.md
line: 15
category: formatting
severity: low
confidence: high
evidence: ": p — Elastic.HeadingColons: Capitalize ': p'."
suggested_fix: |
Capitalize the word after the colon in the heading.
- file: deploy-manage/production-guidance/kibana-task-manager-scaling-considerations.md
line: 147
category: word-choice
severity: low
confidence: high
evidence: "In addition — Elastic.Wordiness: Consider using 'also' instead of 'In addition'."
suggested_fix: |
also
- file: deploy-manage/production-guidance/kibana-traffic-scaling-considerations.md
line: 81
category: word-choice
severity: low
confidence: high
evidence: "In order to — Elastic.Wordiness: Consider using 'to' instead of 'In order to'."
suggested_fix: |
to
- file: deploy-manage/production-guidance/optimize-performance/approximate-knn-search.md
line: 30
category: formatting
severity: low
confidence: high
evidence: "\"sizes\", — Elastic.QuotesPunctuation: Place punctuation inside closing quotation marks."
suggested_fix: |
Move the punctuation inside the closing quotation mark.
- file: deploy-manage/production-guidance/optimize-performance/approximate-knn-search.md
line: 30
category: word-choice
severity: low
confidence: high
evidence: "and higher — Elastic.Versions: Use 'and later' instead of 'and higher' when referring to versions."
suggested_fix: |
and later
- file: deploy-manage/production-guidance/optimize-performance/approximate-knn-search.md
line: 53
category: word-choice
severity: low
confidence: high
evidence: "in most cases — Elastic.Wordiness: Consider using 'usually' instead of 'in most cases'."
suggested_fix: |
usually
- file: deploy-manage/production-guidance/optimize-performance/disk-usage.md
line: 16
category: word-choice
severity: low
confidence: high
evidence: "eliminate — Elastic.Wordiness: Consider using 'remove' instead of 'eliminate'."
suggested_fix: |
remove
- file: deploy-manage/production-guidance/optimize-performance/disk-usage.md
line: 45
category: word-choice
severity: low
confidence: high
evidence: "in order to — Elastic.Wordiness: Consider using 'to' instead of 'in order to'."
suggested_fix: |
to
- file: deploy-manage/production-guidance/optimize-performance/disk-usage.md
line: 68
category: word-choice
severity: low
confidence: high
evidence: "e.g — Elastic.Latinisms: Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'."
suggested_fix: |
for example
- file: deploy-manage/production-guidance/optimize-performance/disk-usage.md
line: 88
category: word-choice
severity: low
confidence: high
evidence: "In many cases — Elastic.Wordiness: Consider using 'often' instead of 'In many cases'."
suggested_fix: |
often
- file: deploy-manage/production-guidance/optimize-performance/disk-usage.md
line: 108
category: word-choice
severity: low
confidence: high
evidence: "in order to — Elastic.Wordiness: Consider using 'to' instead of 'in order to'."
suggested_fix: |
to
- file: deploy-manage/production-guidance/optimize-performance/disk-usage.md
line: 115
category: word-choice
severity: low
confidence: high
evidence: "Due to the fact that — Elastic.Wordiness: Consider using 'because' instead of 'Due to the fact that'."
suggested_fix: |
because
- file: deploy-manage/production-guidance/optimize-performance/indexing-speed.md
line: 26
category: word-choice
severity: low
confidence: high
evidence: "etc — Elastic.Latinisms: Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'."
suggested_fix: |
and so on
- file: deploy-manage/production-guidance/optimize-performance/indexing-speed.md
line: 26
category: word-choice
severity: low
confidence: high
evidence: "In order to — Elastic.Wordiness: Consider using 'to' instead of 'In order to'."
suggested_fix: |
to
- file: deploy-manage/production-guidance/optimize-performance/indexing-speed.md
line: 34
category: word-choice
severity: low
confidence: high
evidence: "In order to — Elastic.Wordiness: Consider using 'to' instead of 'In order to'."
suggested_fix: |
to
- file: deploy-manage/production-guidance/optimize-performance/indexing-speed.md
line: 48
category: word-choice
severity: low
confidence: high
evidence: "e.g — Elastic.Latinisms: Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'."
suggested_fix: |
for example
- file: deploy-manage/production-guidance/optimize-performance/indexing-speed.md
line: 48
category: word-choice
severity: low
confidence: high
evidence: "In order to — Elastic.Wordiness: Consider using 'to' instead of 'In order to'."
suggested_fix: |
to
- file: deploy-manage/production-guidance/optimize-performance/indexing-speed.md
line: 50
category: word-choice
severity: low
confidence: high
evidence: "e.g — Elastic.Latinisms: Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'."
suggested_fix: |
for example
- file: deploy-manage/production-guidance/optimize-performance/indexing-speed.md
line: 142
category: word-choice
severity: low
confidence: high
evidence: "vs — Elastic.Latinisms: Latin terms and abbreviations are a common source of confusion. Use 'versus' instead of 'vs'."
suggested_fix: |
versus
- file: deploy-manage/production-guidance/optimize-performance/search-speed.md
line: 72
category: word-choice
severity: low
confidence: high
evidence: "vs — Elastic.Latinisms: Latin terms and abbreviations are a common source of confusion. Use 'versus' instead of 'vs'."
suggested_fix: |
versus
- file: deploy-manage/production-guidance/optimize-performance/search-speed.md
line: 262
category: word-choice
severity: low
confidence: high
evidence: "in order to — Elastic.Wordiness: Consider using 'to' instead of 'in order to'."
suggested_fix: |
to
- file: deploy-manage/production-guidance/optimize-performance/search-speed.md
line: 306
category: word-choice
severity: low
confidence: high
evidence: "in some cases — Elastic.Wordiness: Consider using 'sometimes' instead of 'in some cases'."
suggested_fix: |
sometimes
- file: deploy-manage/production-guidance/optimize-performance/search-speed.md
line: 349
category: word-choice
severity: low
confidence: high
evidence: "in order to — Elastic.Wordiness: Consider using 'to' instead of 'in order to'."
suggested_fix: |
to
- file: deploy-manage/production-guidance/optimize-performance/search-speed.md
line: 356
category: word-choice
severity: low
confidence: high
evidence: "in order to — Elastic.Wordiness: Consider using 'to' instead of 'in order to'."
suggested_fix: |
to
- file: deploy-manage/production-guidance/optimize-performance/search-speed.md
line: 361
category: word-choice
severity: low
confidence: high
evidence: "in order to — Elastic.Wordiness: Consider using 'to' instead of 'in order to'."
suggested_fix: |
to
- file: deploy-manage/production-guidance/optimize-performance/search-speed.md
line: 430
category: word-choice
severity: low
confidence: high
evidence: "etc — Elastic.Latinisms: Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'."
suggested_fix: |
and so on
- file: deploy-manage/production-guidance/optimize-performance/size-shards.md
line: 34
category: word-choice
severity: low
confidence: high
evidence: "in order to — Elastic.Wordiness: Consider using 'to' instead of 'in order to'."
suggested_fix: |
to
- file: deploy-manage/production-guidance/optimize-performance/size-shards.md
line: 62
category: word-choice
severity: low
confidence: high
evidence: "a large number of — Elastic.Wordiness: Consider using 'many' instead of 'a large number of'."
suggested_fix: |
many
- file: deploy-manage/production-guidance/optimize-performance/size-shards.md
line: 67
category: word-choice
severity: low
confidence: high
evidence: "In most cases — Elastic.Wordiness: Consider using 'usually' instead of 'In most cases'."
suggested_fix: |
usually
- file: deploy-manage/production-guidance/optimize-performance/size-shards.md
line: 235
category: grammar
severity: low
confidence: high
evidence: "indexing, searches and aggregations. — Elastic.OxfordComma: Use the Oxford comma in 'indexing, searches and aggregations.'."
suggested_fix: |
Add an Oxford comma before "and".
- file: deploy-manage/production-guidance/optimize-performance/size-shards.md
line: 271
category: word-choice
severity: low
confidence: high
evidence: "In many cases — Elastic.Wordiness: Consider using 'often' instead of 'In many cases'."
suggested_fix: |
often
- file: deploy-manage/production-guidance/availability-and-resilience.md
line: 28
category: word-choice
severity: medium
confidence: high
evidence: "simply — Elastic.WordChoice: Consider using 'efficiently' instead of 'simply', unless the term is in the UI."
suggested_fix: |
efficiently
- file: deploy-manage/production-guidance/availability-and-resilience/resilience-in-larger-clusters.md
line: 24
category: word-choice
severity: medium
confidence: high
evidence: "may — Elastic.WordChoice: Consider using 'can, might' instead of 'may', unless the term is in the UI."
suggested_fix: |
can, might
- file: deploy-manage/production-guidance/availability-and-resilience/resilience-in-larger-clusters.md
line: 26
category: word-choice
severity: medium
confidence: high
evidence: "may — Elastic.WordChoice: Consider using 'can, might' instead of 'may', unless the term is in the UI."
suggested_fix: |
can, might
- file: deploy-manage/production-guidance/availability-and-resilience/resilience-in-larger-clusters.md
line: 48
category: accessibility
severity: medium
confidence: high
evidence: "described above — Elastic.DirectionalLanguage: Don't use directional language. Use 'earlier on this page' instead of 'described above'."
suggested_fix: |
earlier on this page
- file: deploy-manage/production-guidance/availability-and-resilience/resilience-in-small-clusters.md
line: 28
category: word-choice
severity: medium
confidence: high
evidence: "may — Elastic.WordChoice: Consider using 'can, might' instead of 'may', unless the term is in the UI."
suggested_fix: |
can, might
- file: deploy-manage/production-guidance/availability-and-resilience/resilience-in-small-clusters.md
line: 35
category: word-choice
severity: medium
confidence: high
evidence: "may — Elastic.WordChoice: Consider using 'can, might' instead of 'may', unless the term is in the UI."
suggested_fix: |
can, might
- file: deploy-manage/production-guidance/availability-and-resilience/resilience-in-small-clusters.md
line: 41
category: word-choice
severity: medium
confidence: high
evidence: "just — Elastic.DontUse: Don't use 'just'."
suggested_fix: |
Remove or rephrase to avoid "just".
- file: deploy-manage/production-guidance/availability-and-resilience/resilience-in-small-clusters.md
line: 48
category: accessibility
severity: medium
confidence: high
evidence: "described above — Elastic.DirectionalLanguage: Don't use directional language. Use 'earlier on this page' instead of 'described above'."
suggested_fix: |
earlier on this page
- file: deploy-manage/production-guidance/availability-and-resilience/resilience-in-small-clusters.md
line: 56
category: word-choice
severity: medium
confidence: high
evidence: "just — Elastic.DontUse: Don't use 'just'."
suggested_fix: |
Remove or rephrase to avoid "just".
- file: deploy-manage/production-guidance/availability-and-resilience/resilience-in-small-clusters.md
line: 63
category: word-choice
severity: medium
confidence: high
evidence: "may — Elastic.WordChoice: Consider using 'can, might' instead of 'may', unless the term is in the UI."
suggested_fix: |
can, might
- file: deploy-manage/production-guidance/availability-and-resilience/resilience-in-small-clusters.md
line: 65
category: word-choice
severity: medium
confidence: high
evidence: "just — Elastic.DontUse: Don't use 'just'."
suggested_fix: |
Remove or rephrase to avoid "just".
- file: deploy-manage/production-guidance/availability-and-resilience/resilience-in-small-clusters.md
line: 72
category: word-choice
severity: medium
confidence: high
evidence: "just — Elastic.DontUse: Don't use 'just'."
suggested_fix: |
Remove or rephrase to avoid "just".
- file: deploy-manage/production-guidance/availability-and-resilience/resilience-in-small-clusters.md
line: 72
category: word-choice
severity: medium
confidence: high
evidence: "may — Elastic.WordChoice: Consider using 'can, might' instead of 'may', unless the term is in the UI."
suggested_fix: |
can, might
- file: deploy-manage/production-guidance/availability-and-resilience/resilience-in-small-clusters.md
line: 74
category: word-choice
severity: medium
confidence: high
evidence: "may — Elastic.WordChoice: Consider using 'can, might' instead of 'may', unless the term is in the UI."
suggested_fix: |
can, might
- file: deploy-manage/production-guidance/kibana-alerting-production-considerations.md
line: 56
category: word-choice
severity: medium
confidence: high
evidence: "may — Elastic.WordChoice: Consider using 'can, might' instead of 'may', unless the term is in the UI."
suggested_fix: |
can, might
- file: deploy-manage/production-guidance/kibana-alerting-production-considerations.md
line: 65
category: word-choice
severity: medium
confidence: high
evidence: "execute — Elastic.WordChoice: Consider using 'run, start' instead of 'execute', unless the term is in the UI."
suggested_fix: |
run, start
- file: deploy-manage/production-guidance/kibana-alerting-production-considerations.md
line: 71
category: word-choice
severity: medium
confidence: high
evidence: "disable — Elastic.WordChoice: Consider using 'deactivate, deselect, hide, turn off' instead of 'disable', unless the term is in the UI."
suggested_fix: |
deactivate, deselect, hide, turn off
- file: deploy-manage/production-guidance/kibana-alerting-production-considerations.md
line: 85
category: word-choice
severity: medium
confidence: high
evidence: "may — Elastic.WordChoice: Consider using 'can, might' instead of 'may', unless the term is in the UI."
suggested_fix: |
can, might
- file: deploy-manage/production-guidance/kibana-reporting-production-considerations.md
line: 18
category: word-choice
severity: medium
confidence: high
evidence: "may — Elastic.WordChoice: Consider using 'can, might' instead of 'may', unless the term is in the UI."
suggested_fix: |
can, might
- file: deploy-manage/production-guidance/kibana-reporting-production-considerations.md
line: 30
category: word-choice
severity: medium
confidence: high
evidence: "may — Elastic.WordChoice: Consider using 'can, might' instead of 'may', unless the term is in the UI."
suggested_fix: |
can, might
- file: deploy-manage/production-guidance/kibana-reporting-production-considerations.md
line: 50
category: word-choice
severity: medium
confidence: high
evidence: "disable — Elastic.WordChoice: Consider using 'deactivate, deselect, hide, turn off' instead of 'disable', unless the term is in the UI."
suggested_fix: |
deactivate, deselect, hide, turn off
- file: deploy-manage/production-guidance/kibana-task-manager-scaling-considerations.md
line: 121
category: word-choice
severity: medium
confidence: high
evidence: "may — Elastic.WordChoice: Consider using 'can, might' instead of 'may', unless the term is in the UI."
suggested_fix: |
can, might
- file: deploy-manage/production-guidance/kibana-task-manager-scaling-considerations.md
line: 151
category: word-choice
severity: medium
confidence: high
evidence: "execute — Elastic.WordChoice: Consider using 'run, start' instead of 'execute', unless the term is in the UI."
suggested_fix: |
run, start
- file: deploy-manage/production-guidance/kibana-task-manager-scaling-considerations.md
line: 159
category: word-choice
severity: medium
confidence: high
evidence: "execute — Elastic.WordChoice: Consider using 'run, start' instead of 'execute', unless the term is in the UI."
suggested_fix: |
run, start
- file: deploy-manage/production-guidance/kibana-traffic-scaling-considerations.md
line: 24
category: word-choice
severity: medium
confidence: high
evidence: "may — Elastic.WordChoice: Consider using 'can, might' instead of 'may', unless the term is in the UI."
suggested_fix: |
can, might
- file: deploy-manage/production-guidance/optimize-performance/approximate-knn-search.md
line: 35
category: word-choice
severity: medium
confidence: high
evidence: "quite — Elastic.DontUse: Don't use 'quite'."
suggested_fix: |
Remove or rephrase to avoid "quite".
- file: deploy-manage/production-guidance/optimize-performance/approximate-knn-search.md
line: 35
category: word-choice
severity: medium
confidence: high
evidence: "hit — Elastic.WordChoice: Consider using 'select, press, visits' instead of 'hit', unless the term is in the UI."
suggested_fix: |
select, press, visits
- file: deploy-manage/production-guidance/optimize-performance/approximate-knn-search.md
line: 42
category: word-choice
severity: medium
confidence: high
evidence: "disable — Elastic.WordChoice: Consider using 'deactivate, deselect, hide, turn off' instead of 'disable', unless the term is in the UI."
suggested_fix: |
deactivate, deselect, hide, turn off
- file: deploy-manage/production-guidance/optimize-performance/approximate-knn-search.md
line: 189
category: word-choice
severity: medium
confidence: high
evidence: "disable — Elastic.WordChoice: Consider using 'deactivate, deselect, hide, turn off' instead of 'disable', unless the term is in the UI."
suggested_fix: |
deactivate, deselect, hide, turn off
- file: deploy-manage/production-guidance/optimize-performance/approximate-knn-search.md
line: 197
category: accessibility
severity: medium
confidence: high
evidence: "mentioned above — Elastic.DirectionalLanguage: Don't use directional language. Use 'earlier on this page' instead of 'mentioned above'."
suggested_fix: |
earlier on this page
- file: deploy-manage/production-guidance/optimize-performance/approximate-knn-search.md
line: 202
category: word-choice
severity: medium
confidence: high
evidence: "may — Elastic.WordChoice: Consider using 'can, might' instead of 'may', unless the term is in the UI."
suggested_fix: |
can, might
- file: deploy-manage/production-guidance/optimize-performance/disk-usage.md
line: 108
category: word-choice
severity: medium
confidence: high
evidence: "quite — Elastic.DontUse: Don't use 'quite'."
suggested_fix: |
Remove or rephrase to avoid "quite".
- file: deploy-manage/production-guidance/optimize-performance/indexing-speed.md
line: 36
category: word-choice
severity: medium
confidence: high
evidence: "may — Elastic.WordChoice: Consider using 'can, might' instead of 'may', unless the term is in the UI."
suggested_fix: |
can, might
- file: deploy-manage/production-guidance/optimize-performance/indexing-speed.md
line: 52
category: word-choice
severity: medium
confidence: high
evidence: "Disable — Elastic.WordChoice: Consider using 'deactivate, deselect, hide, turn off' instead of 'Disable', unless the term is in the UI."
suggested_fix: |
deactivate, deselect, hide, turn off
- file: deploy-manage/production-guidance/optimize-performance/search-speed.md
line: 214
category: accessibility
severity: medium
confidence: high
evidence: "the below query — Elastic.DirectionalLanguage: Don't use directional language. Use 'the following [element]' instead of 'the below query'."
suggested_fix: |
the following [element]
- file: deploy-manage/production-guidance/optimize-performance/search-speed.md
line: 262
category: accessibility
severity: medium
confidence: high
evidence: "as shown below — Elastic.DirectionalLanguage: Don't use directional language. Use 'in the following example' instead of 'as shown below'."
suggested_fix: |
in the following example
- file: deploy-manage/production-guidance/optimize-performance/size-shards.md
line: 34
category: word-choice
severity: medium
confidence: high
evidence: "may — Elastic.WordChoice: Consider using 'can, might' instead of 'may', unless the term is in the UI."
suggested_fix: |
can, might
- file: deploy-manage/production-guidance/optimize-performance/size-shards.md
line: 73
category: word-choice
severity: medium
confidence: high
evidence: "and/or — Elastic.DontUse: Don't use 'and/or'."
suggested_fix: |
Remove or rephrase to avoid "and/or".
- file: deploy-manage/production-guidance/optimize-performance/size-shards.md
line: 112
category: word-choice
severity: medium
confidence: high
evidence: "just — Elastic.DontUse: Don't use 'just'."
suggested_fix: |
Remove or rephrase to avoid "just".
- file: deploy-manage/production-guidance/optimize-performance/size-shards.md
line: 116
category: grammar
severity: medium
confidence: high
evidence: "to to — Elastic.Repetition: \"to\" is repeated."
suggested_fix: |
Remove the duplicated word.
- file: deploy-manage/production-guidance/optimize-performance/size-shards.md
line: 137
category: word-choice
severity: medium
confidence: high
evidence: "Clone — Elastic.Clone: Use `Clone` only when referring to cloning a GitHub repository or creating a copy that is linked to the original. Often confused with 'copy' and 'duplicate'."
suggested_fix: |
Use `Clone` only when referring to cloning a GitHub repository or creating a copy that is linked to the original. Often confused with 'copy' and 'duplicate'.
- file: deploy-manage/production-guidance/optimize-performance/size-shards.md
line: 137
category: word-choice
severity: medium
confidence: high
evidence: "and/or — Elastic.DontUse: Don't use 'and/or'."
suggested_fix: |
Remove or rephrase to avoid "and/or".
- file: deploy-manage/production-guidance/optimize-performance/size-shards.md
line: 202
category: accessibility
severity: medium
confidence: high
evidence: "mentioned above — Elastic.DirectionalLanguage: Don't use directional language. Use 'earlier on this page' instead of 'mentioned above'."
suggested_fix: |
earlier on this page
- file: deploy-manage/production-guidance/optimize-performance/size-shards.md
line: 246
category: word-choice
severity: medium
confidence: high
evidence: "thus — Elastic.DontUse: Don't use 'thus'."
suggested_fix: |
Remove or rephrase to avoid "thus".
- file: deploy-manage/production-guidance/scaling-considerations.md
line: 18
category: word-choice
severity: medium
confidence: high
evidence: "hit — Elastic.WordChoice: Consider using 'select, press, visits' instead of 'hit', unless the term is in the UI."
suggested_fix: |
select, press, visits
- file: deploy-manage/production-guidance/scaling-considerations.md
line: 30
category: word-choice
severity: medium
confidence: high
evidence: "may — Elastic.WordChoice: Consider using 'can, might' instead of 'may', unless the term is in the UI."
suggested_fix: |
can, might
- file: deploy-manage/production-guidance/scaling-considerations.md
line: 34
category: word-choice
severity: medium
confidence: high
evidence: "just — Elastic.DontUse: Don't use 'just'."
suggested_fix: |
Remove or rephrase to avoid "just".
- file: deploy-manage/production-guidance/scaling-considerations.md
line: 48
category: word-choice
severity: medium
confidence: high
evidence: "Just — Elastic.DontUse: Don't use 'Just'."
suggested_fix: |
Remove or rephrase to avoid "Just".
```

## Done when
- All listed lines pass the Elastic style guide rules cited.
- A PR addressing this issue is merged.

## Notes
- Findings are capped to 5 sampled occurrences of `Elastic.WordChoice`/`Elastic.Wordiness` per file (word-choice nits like "may", "in order to", "disable") to keep the issue actionable; the remaining occurrences follow the same fix and are not individually listed.
- `Elastic.MappedPages` findings (front-matter `mapped_pages` key) were excluded — Vale flags them as "talk to a technical writer before changing," which is not an actionable style fix for this sweep.

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

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the listed findings under deploy-manage/production-guidance, including availability-and-resilience.md, the resilience pages, Kibana production-considerations pages, and optimize-performance/*.md. Review each cited line and apply its suggested wording or formatting change. Done means all 92 findings across the 20 in-scope pages have been addressed and the documentation style sweep reports no remaining findings.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
64/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.