elastic / elastic/docs-content

Docs fix — style: shard 1/1 — 16 pages

Open Beginner friendly
#6,996 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 21h
Merged PRs (30d)
141

Description

Generated by `gh-aw-docs-style-sweep` for `elastic/docs-content` on 2026-W25.

Shard 1/1 · 16 pages in slice · 0 recently-changed · 16 total in scope · corpus 16 pages.

## Findings (20)

```yaml
- file: explore-analyze/alerting/alerts/alerting-common-issues.md
line: 158
category: word-choice
severity: medium
evidence: "'unable to use runtime fields' — Elastic.WordChoice prefers 'cannot'"
suggested_fix: |
cannot use runtime fields

- file: explore-analyze/alerting/alerts/alerting-setup.md
line: 25
category: word-choice
severity: medium
evidence: "'If you are unable to access' — Elastic.WordChoice prefers 'cannot'"
suggested_fix: |
If you cannot access

- file: explore-analyze/alerting/alerts/geo-alerting.md
line: 32
category: grammar
severity: medium
evidence: "'\"real time\",' — Elastic.QuotesPunctuation: punctuation should be inside closing quotation marks"
suggested_fix: |
"real time,"

- file: explore-analyze/alerting/alerts/view-alerts.md
line: 18
category: ui-writing
severity: medium
evidence: "'Alerts and Insights > Rules' — Elastic.MenuArrows: use '→' to separate menu items, not '>'"
suggested_fix: |
Alerts and Insights → Rules

- file: explore-analyze/alerting/alerts/view-alerts.md
line: 20
category: ui-writing
severity: medium
evidence: "'Stack Management > Alerts' — Elastic.MenuArrows: use '→' to separate menu items, not '>'"
suggested_fix: |
Stack Management → Alerts

- file: explore-analyze/alerting/alerts/view-alerts.md
line: 21
category: ui-writing
severity: medium
evidence: "'Alerts and Insights > Alerts' — Elastic.MenuArrows: use '→' to separate menu items, not '>'"
suggested_fix: |
Alerts and Insights → Alerts

- file: explore-analyze/alerting/alerts/view-alerts.md
line: 175
category: ui-writing
severity: medium
evidence: "'Stack Management > Alerts and Insights > Rules' — Elastic.MenuArrows: use '→' to separate menu items, not '>'"
suggested_fix: |
Stack Management → Alerts and Insights → Rules

- file: explore-analyze/alerting/alerts/alerting-common-issues.md
line: 84
category: word-choice
severity: low
evidence: "'may produce unexpected results' — Elastic.WordChoice: prefer 'might' for possibility"
suggested_fix: |
might produce unexpected results

- file: explore-analyze/alerting/alerts/alerting-getting-started.md
line: 30
category: word-choice
severity: low
evidence: "'all of these' — Elastic.Wordiness: prefer 'these'"
suggested_fix: |
these

- file: explore-analyze/alerting/alerts/alerting-getting-started.md
line: 122
category: word-choice
severity: low
evidence: "'some of the' — Elastic.Wordiness: prefer 'some'"
suggested_fix: |
some

- file: explore-analyze/alerting/alerts/alerting-setup.md
line: 104
category: grammar
severity: low
evidence: "';' — Elastic.Semicolons: 'provide a username and password; an API key ... is created automatically' — consider splitting into two sentences"
suggested_fix: |
provide a username and password. An API key that matches the current privileges of the user is created automatically.

- file: explore-analyze/alerting/alerts/alerting-setup.md
line: 113
category: word-choice
severity: low
evidence: "'may wish to limit' — Elastic.WordChoice: prefer 'might' for possibility"
suggested_fix: |
might want to limit

- file: explore-analyze/alerting/alerts/alerting-troubleshooting.md
line: 18
category: word-choice
severity: low
evidence: "'In some cases' — Elastic.Wordiness: prefer 'Sometimes'"
suggested_fix: |
Sometimes

- file: explore-analyze/alerting/alerts/alerting-troubleshooting.md
line: 24
category: word-choice
severity: low
evidence: "'Some of the resources' — Elastic.Wordiness: prefer 'some resources'"
suggested_fix: |
some resources

- file: explore-analyze/alerting/alerts/alerting-troubleshooting.md
line: 24
category: word-choice
severity: low
evidence: "'resources ... may no longer be available' — Elastic.WordChoice: prefer 'might' for possibility"
suggested_fix: |
might no longer be available

- file: explore-analyze/alerting/alerts/alerting-troubleshooting.md
line: 35
category: word-choice
severity: low
evidence: "'In addition,' — Elastic.Wordiness: prefer 'Also'"
suggested_fix: |
Also,

- file: explore-analyze/alerting/alerts/alerting-troubleshooting.md
line: 68
category: word-choice
severity: low
evidence: "'In addition,' — Elastic.Wordiness: prefer 'Also'"
suggested_fix: |
Also,

- file: explore-analyze/alerting/alerts/create-manage-rules.md
line: 81
category: grammar
severity: low
evidence: "';' — Elastic.Semicolons: 'Checks are queued; they run as close to the defined value as capacity allows' — consider splitting into two sentences"
suggested_fix: |
Checks are queued. They run as close to the defined value as capacity allows.

- file: explore-analyze/alerting/alerts/create-manage-rules.md
line: 126
category: word-choice
severity: low
evidence: "'a large number of' — Elastic.Wordiness: prefer 'many'"
suggested_fix: |
many

- file: explore-analyze/alerting/alerts/rule-action-variables.md
line: 304
category: word-choice
severity: low
evidence: "'may contain values that are escaped' — Elastic.WordChoice: prefer 'might' for possibility"
suggested_fix: |
might contain values that are escaped
```

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

## Notes
- Skipped `Elastic.MappedPages` warnings (operational frontmatter advisory, not a style fix). Skipped `mute`/`disable` WordChoice findings where context confirms these are established UI terms in the product.

> Generated by [Docs style sweep agent](https://github.com/elastic/docs-content/actions/runs/27794970831) · 218.8 AIC · ⌖ 13.3 AIC · ⊞ 26.7K · [◷](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 lines in the eight alerting Markdown files, using the cited Elastic.WordChoice, Elastic.Wordiness, Elastic.QuotesPunctuation, Elastic.MenuArrows, and Elastic.Semicolons findings as the guide. Apply the documented style corrections, then run the repository's documentation style checks; done means all listed lines pass and a pull request addressing the issue is merged.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.