elastic / elastic/opentelemetry

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

Open
#614 0 comments 1 reaction 2 assignees Claimed by @theletterf View on GitHub
docs-fix:style docs-quality-sweep
Dominant language
Python
Stars
37
Forks
50
Avg merge
23h 31m
Merged PRs (30d)
3

Description

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

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

## Findings (17)

```yaml
- file: docs/reference/compatibility/limitations.md
line: 85
category: ui-writing
severity: medium
evidence: "'Service > Metrics' — Elastic.MenuArrows: use '→' to separate menu items, not '>'"
suggested_fix: |
**Service → Metrics**

- file: docs/reference/compatibility/sdks.md
line: 62
category: accessibility
severity: medium
evidence: "'listed above' — Elastic.DirectionalLanguage: avoid directional language"
suggested_fix: |
in the preceding section

- file: docs/reference/edot-sdks/index.md
line: 72
category: ui-writing
severity: medium
evidence: "'Service > Metrics' — Elastic.MenuArrows: use '→' to separate menu items, not '>'"
suggested_fix: |
APM Service → Metrics

- file: docs/reference/motlp/troubleshooting.md
line: 127
category: ui-writing
severity: medium
evidence: "'AutoOps Monitoring > Nodes' — Elastic.MenuArrowsBold: use '→' to separate menu items, not '>'"
suggested_fix: |
**AutoOps Monitoring → Nodes**

- file: docs/reference/architecture/index.md
line: 74
category: word-choice
severity: low
evidence: "'may' — Elastic.WordChoice: prefer 'can' or 'might' over 'may'"
suggested_fix: |
While some data can ingest, Elastic doesn't guarantee ...

- file: docs/reference/compatibility/collectors.md
line: 46
category: word-choice
severity: low
evidence: "'and higher' — Elastic.Versions: use 'and later' when referring to versions"
suggested_fix: |
macOS 10.x and later

- file: docs/reference/compatibility/collectors.md
line: 47
category: word-choice
severity: low
evidence: "'and higher' — Elastic.Versions: use 'and later' when referring to versions"
suggested_fix: |
macOS 10.x and later

- file: docs/reference/compatibility/data-streams.md
line: 64
category: word-choice
severity: low
evidence: "'may' — Elastic.WordChoice: prefer 'can' or 'might' over 'may'"
suggested_fix: |
Some integration-specific fields might require query changes.

- file: docs/reference/compatibility/data-streams.md
line: 67
category: word-choice
severity: low
evidence: "'may' — Elastic.WordChoice: prefer 'can' or 'might' over 'may'"
suggested_fix: |
These differences might require updates to certain queries or visualizations.

- file: docs/reference/compatibility/data-streams.md
line: 159
category: word-choice
severity: low
evidence: "'may' — Elastic.WordChoice: prefer 'can' or 'might' over 'may'"
suggested_fix: |
Some integration fields might not align 1:1 with ECS or OTel.

- file: docs/reference/compatibility/limitations.md
line: 23
category: word-choice
severity: low
evidence: "'may' — Elastic.WordChoice: prefer 'can' or 'might' over 'may'"
suggested_fix: |
you might prefer to use classic Elastic ingestion components

- file: docs/reference/compatibility/limitations.md
line: 38
category: accessibility
severity: low
evidence: "'can't access fields that have a dot in their name without' — Elastic.Negations: rephrase to avoid negative construction for international audience"
suggested_fix: |
Ingest Pipeline processors require fields with dots to first be transformed into objects (using the Dot expander processor) before they can be accessed.

- file: docs/reference/compatibility/limitations.md
line: 52
category: word-choice
severity: low
evidence: "'may' (×2) — Elastic.WordChoice: prefer 'can' or 'might' over 'may'"
suggested_fix: |
Host OS version and operating system might show as "N/A". ... it might not populate these values.

- file: docs/reference/compatibility/limitations.md
line: 55
category: word-choice
severity: low
evidence: "'may' — Elastic.WordChoice: prefer 'can' or 'might' over 'may'"
suggested_fix: |
Permission issues might cause error logs for process metrics

- file: docs/reference/compatibility/nomenclature.md
line: 21
category: word-choice
severity: low
evidence: "'may' — Elastic.WordChoice: prefer 'can' or 'might' over 'may'"
suggested_fix: |
Components outside of this supported set might still work, but Elastic does not provide guaranteed support ...

- file: docs/reference/compatibility/sdks.md
line: 38
category: word-choice
severity: low
evidence: "'or higher' — Elastic.Versions: use 'or later' when referring to versions"
suggested_fix: |
Elastic Stack versions 8.18 or later

- file: docs/reference/data-streams.md
line: 78
category: word-choice
severity: low
evidence: "'may' — Elastic.WordChoice: prefer 'can' or 'might' over 'may'"
suggested_fix: |
You might notice fields like:
```

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

## Notes
- Single-word misspellings are excluded (handled by the typos sweep).

> Generated by [Docs style sweep agent](https://github.com/elastic/opentelemetry/actions/runs/27820350836) · 148.2 AIC · ⌖ 35.9 AIC · ⊞ 33.5K · [◷](https://github.com/search?q=repo%3Aelastic%2Fopentelemetry+is%3Aissue+%22gh-aw-workflow-call-id%3A+elastic%2Fopentelemetry%2Fgh-aw-docs-style-sweep%22&type=issues)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.