Skip to content

Fix typos in autodiscover/module docs and field descriptions#49504

Open
Copilot wants to merge 3 commits intomainfrom
copilot/text-auditor-fix-typo-families
Open

Fix typos in autodiscover/module docs and field descriptions#49504
Copilot wants to merge 3 commits intomainfrom
copilot/text-auditor-fix-typo-families

Conversation

Copy link
Contributor

Copilot AI commented Mar 16, 2026

Fix 7 typo families across 19 files in user-facing docs and field descriptions.

  • configrationconfiguration — 3 autodiscover reference docs (filebeat, heartbeat, metricbeat)
  • not fileno file — 4 filebeat reference/config files
  • realtiverelative — 3 heartbeat browser field descriptions
  • endpontsendpoints — 3 O365 module docs
  • formatedformatted — 3 CrowdStrike module docs
  • currnetcurrent — 3 DHCPv4 field descriptions
  • recomendedrecommended — 3 O365 module docs
Original prompt

This section details on the original issue you should resolve

<issue_title>[text-auditor] Fix clear typo families in autodiscover/module docs and field descriptions</issue_title>
<issue_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? | From workflow: Text Auditor

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

  • expires on Mar 23, 2026, 1:46 PM UTC

Comments ...


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Mar 16, 2026
@mergify
Copy link
Contributor

mergify bot commented Mar 16, 2026

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @Copilot? 🙏.
For such, you'll need to label your PR with:

  • The upcoming major version of the Elastic Stack
  • The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-8./d is the label to automatically backport to the 8./d branch. /d is the digit
  • backport-active-all is the label that automatically backports to all active branches.
  • backport-active-8 is the label that automatically backports to all active minor branches for the 8 major.
  • backport-active-9 is the label that automatically backports to all active minor branches for the 9 major.

Fix 7 typo families:
- configration → configuration (3 autodiscover docs)
- not file → no file (4 Filebeat reference configs)
- realtive → relative (3 Heartbeat field descriptions)
- endponts → endpoints (3 O365 module docs)
- formated → formatted (3 CrowdStrike module docs)
- currnet → current (3 DHCPv4 field descriptions)
- recomended → recommended (3 O365 docs)

Co-authored-by: strawgate <6384545+strawgate@users.noreply.github.com>
Copilot AI changed the title [WIP] [text-auditor] Fix clear typo families in autodiscover/module docs and field descriptions Fix typos in autodiscover/module docs and field descriptions Mar 16, 2026
Copilot AI requested a review from strawgate March 16, 2026 22:15
@strawgate strawgate marked this pull request as ready for review March 23, 2026 15:42
@strawgate strawgate requested review from a team as code owners March 23, 2026 15:42
@github-actions
Copy link
Contributor

Vale Linting Results

Summary: 1 warning, 1 suggestion found

⚠️ Warnings (1)
File Line Rule Message
docs/reference/filebeat/filebeat-module-o365.md 116 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'and so on' instead of 'etc'.
💡 Suggestions (1)
File Line Rule Message
docs/reference/filebeat/filebeat-module-o365.md 116 Elastic.Wordiness Consider using 'to' instead of 'In order to'.

The Vale linter checks documentation changes against the Elastic Docs style guide.

To use Vale locally or report issues, refer to Elastic style guide for Vale.

@coderabbitai
Copy link

coderabbitai bot commented Mar 23, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 085ccdc4-abdc-457f-b1d3-a5c0521cd324

📥 Commits

Reviewing files that changed from the base of the PR and between 11d1fe7 and e886a3b.

📒 Files selected for processing (19)
  • docs/reference/filebeat/configuration-autodiscover.md
  • docs/reference/filebeat/filebeat-module-crowdstrike.md
  • docs/reference/filebeat/filebeat-module-o365.md
  • docs/reference/filebeat/filebeat-reference-yml.md
  • docs/reference/heartbeat/configuration-autodiscover.md
  • docs/reference/heartbeat/exported-fields-browser.md
  • docs/reference/metricbeat/configuration-autodiscover.md
  • docs/reference/packetbeat/exported-fields-dhcpv4.md
  • filebeat/_meta/config/filebeat.inputs.reference.yml.tmpl
  • filebeat/docs/modules/crowdstrike.asciidoc
  • filebeat/docs/modules/o365.asciidoc
  • filebeat/filebeat.reference.yml
  • heartbeat/_meta/fields.common.yml
  • heartbeat/docs/fields.asciidoc
  • packetbeat/docs/fields.asciidoc
  • packetbeat/protos/dhcpv4/_meta/fields.yml
  • x-pack/filebeat/filebeat.reference.yml
  • x-pack/filebeat/module/crowdstrike/_meta/docs.md
  • x-pack/filebeat/module/o365/_meta/docs.md

📝 Walkthrough

Walkthrough

This pull request corrects spelling and grammar errors across documentation files in the Beats repository. Changes include fixing "configration" to "configuration" in autodiscover reference docs, "not file" to "no file" in Filebeat configuration comments, "realtive" to "relative" in Heartbeat field descriptions, "endponts" to "endpoints" and "recomended" to "recommended" in O365 module documentation, "formated" to "formatted" in CrowdStrike module docs, and "currnet" to "current" in DHCPv4 field descriptions. All modifications are documentation-only with no configuration keys, values, structure, or behavioral changes.

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Linked Issues check ✅ Passed All seven typo family corrections from issue #49496 were successfully applied across 22 files matching the specified objectives.
Out of Scope Changes check ✅ Passed Changes are limited to documented typo corrections; no out-of-scope modifications detected.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch copilot/text-auditor-fix-typo-families
  • 🛠️ Update Documentation: Commit on current branch
  • 🛠️ Update Documentation: Create PR

Comment @coderabbitai help to get the list of available commands and usage tips.

@theletterf theletterf added the Team:Docs Label for the Observability docs team label Mar 23, 2026
@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Mar 23, 2026
@theletterf theletterf added skip-test-plan skip-ci Skip the build in the CI but linting backport-skip Skip notification from the automated backport with mergify skip-changelog labels Mar 23, 2026
@github-actions
Copy link
Contributor

TL;DR

check-docs failed in make check because generated code is out of date (heartbeat/include/fields.go was modified during CI generation). Run make update, commit regenerated files, and rerun checks.

Remediation

  • From the PR branch, run make update at repo root.
  • Stage and commit generated changes (at minimum heartbeat/include/fields.go; include any other files changed by update).
  • Re-run make check locally to confirm no generated-file drift before pushing.
Investigation details

Root Cause

The workflow’s check job reached the Heartbeat check phase, regenerated artifacts, then failed the repository cleanliness check because a generated file changed and was not committed.

Evidence

2026-03-23T15:50:54.5602340Z Error: some files are not up-to-date. Run 'make update' then review and commit the changes. Modified: [heartbeat/include/fields.go]
2026-03-23T15:50:54.5627342Z make: *** [Makefile:84: check] Error 1
2026-03-23T15:50:54.5645805Z ##[error]Process completed with exit code 2.

Validation

  • Reviewed failed job list for run 23446050208 (single failing job: check).
  • Parsed failed job log content and confirmed deterministic generated-file drift failure.
  • Local repro not run in this workflow context (read-only detective run).

Follow-up

If the regenerated diff in heartbeat/include/fields.go is unexpected, verify whether source field definitions were edited in this PR (or by merge-from-main) and regenerate once more from latest main.


What is this? | From workflow: PR Actions Detective

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

Copy link
Contributor

@efd6 efd6 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

crowdstrike and o365 changes LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-skip Skip notification from the automated backport with mergify skip-changelog skip-ci Skip the build in the CI but linting skip-test-plan Team:Docs Label for the Observability docs team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

4 participants