elastic / elastic/beats

[text-auditor] Fix clear typo families in autodiscover/module docs and field descriptions

Open
#49,496 1 comment 1 reaction 2 assignees Claimed by @strawgate View on GitHub
needs_team
Dominant language
Go
Stars
12.7k
Forks
5k
Avg merge
2d 15m
Merged PRs (30d)
385

Description

## Text Improvements

The following user-facing text issues were found in the repository. Each is a low-effort fix with complete in-repo occurrence coverage for its typo family.

### 1. `configration` typo in autodiscover reference docs (3 occurrences)

**Files:**
- `docs/reference/filebeat/configuration-autodiscover.md` (line 229)
- `docs/reference/heartbeat/configuration-autodiscover.md` (line 130)
- `docs/reference/metricbeat/configuration-autodiscover.md` (line 150)

**Current text:** `Specify filters and configration for the extra metadata...`

**Suggested fix:** `Specify filters and configuration for the extra metadata...`

**Why:** Clear spelling typo in user-facing reference docs.

### 2. Grammar typo `not file` in Filebeat reference configuration comments (4 occurrences)

**Files:**
- `filebeat/filebeat.reference.yml` (line 667)
- `filebeat/_meta/config/filebeat.inputs.reference.yml.tmpl` (line 254)
- `x-pack/filebeat/filebeat.reference.yml` (line 2367)
- `docs/reference/filebeat/filebeat-reference-yml.md` (line 687)

**Current text:** `Make sure not file is defined twice as this can lead to unexpected behaviour.`

**Suggested fix:** `Make sure no file is defined twice as this can lead to unexpected behaviour.`

**Why:** Clear grammatical error in user-facing configuration guidance.

### 3. `realtive` typo in Heartbeat field descriptions (3 occurrences)

**Files:**
- `heartbeat/_meta/fields.common.yml` (line 369)
- `heartbeat/docs/fields.asciidoc` (line 187)
- `docs/reference/heartbeat/exported-fields-browser.md` (line 63)

**Current text:** `...are realtive to...`

**Suggested fix:** `...are relative to...`

**Why:** Clear spelling typo repeated across source and generated/reference docs.

### 4. `endponts` typo in O365 module docs (3 occurrences)

**Files:**
- `filebeat/docs/modules/o365.asciidoc` (line 107)
- `x-pack/filebeat/module/o365/_meta/docs.md` (line 104)
- `docs/reference/filebeat/filebeat-module-o365.md` (line 116)

**Current text:** `...alternative endpoints (GCC High endponts, U.S. DoD...)`

**Suggested fix:** `...alternative endpoints (GCC High endpoints, U.S. DoD...)`

**Why:** Clear spelling typo in user-facing module documentation.

### 5. `formated` typo in CrowdStrike module docs (3 occurrences)

**Files:**
- `filebeat/docs/modules/crowdstrike.asciidoc` (line 39)
- `x-pack/filebeat/module/crowdstrike/_meta/docs.md` (line 56)
- `docs/reference/filebeat/filebeat-module-crowdstrike.md` (line 68)

**Current text:** `JSON formated event data`

**Suggested fix:** `JSON formatted event data`

**Why:** Clear spelling typo in user-facing module documentation.

### 6. `currnet` typo in DHCPv4 exported field descriptions (3 occurrences)

**Files:**
- `packetbeat/protos/dhcpv4/_meta/fields.yml` (line 149)
- `packetbeat/docs/fields.asciidoc` (line 1730)
- `docs/reference/packetbeat/exported-fields-dhcpv4.md` (line 152)

**Current text:** `...on the currnet network.`

**Suggested fix:** `...on the current network.`

**Why:** Clear spelling typo in exported field text.

### 7. `recomended` typo in O365 docs (3 occurrences)

**Files:**
- `filebeat/docs/modules/o365.asciidoc` (line 166)
- `x-pack/filebeat/module/o365/_meta/docs.md` (line 148)
- `docs/reference/filebeat/filebeat-module-o365.md` (line 160)

**Current text:** `The following configuration options are only recomended...`

**Suggested fix:** `The following configuration options are only recommended...`

**Why:** Clear spelling typo in user-facing configuration docs.

## Suggested Actions

- [ ] Replace `configration` with `configuration` in all 3 autodiscover docs listed above.
- [ ] Replace `not file` with `no file` in all 4 Filebeat reference/config doc occurrences listed above.
- [ ] Replace `realtive` with `relative` in all 3 Heartbeat field-description occurrences.
- [ ] Replace `endponts` with `endpoints` in all 3 O365 docs occurrences.
- [ ] Replace `formated` with `formatted` in all 3 CrowdStrike docs occurrences.
- [ ] Replace `currnet` with `current` in all 3 DHCPv4 field-description occurrences.
- [ ] Replace `recomended` with `recommended` in all 3 O365 docs occurrences.

---
[What is this?](https://ela.st/github-ai-tools) | [From workflow: Text Auditor](https://github.com/elastic/beats/actions/runs/23146445932)

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.
> - [x] expires on Mar 23, 2026, 1:46 PM UTC

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.