Fix typos in autodiscover/module docs and field descriptions#49504
Draft
Fix typos in autodiscover/module docs and field descriptions#49504
Conversation
|
This pull request doesn't have a |
Contributor
|
This pull request does not have a backport label.
To fixup this pull request, you need to add the backport labels for the needed
|
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fix 7 typo families across 19 files in user-facing docs and field descriptions.
configration→configuration— 3 autodiscover reference docs (filebeat, heartbeat, metricbeat)not file→no file— 4 filebeat reference/config filesrealtive→relative— 3 heartbeat browser field descriptionsendponts→endpoints— 3 O365 module docsformated→formatted— 3 CrowdStrike module docscurrnet→current— 3 DHCPv4 field descriptionsrecomended→recommended— 3 O365 module docsOriginal 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.
configrationtypo 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 filein 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.
realtivetypo 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.
endpontstypo 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.
formatedtypo 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 dataSuggested fix:
JSON formatted event dataWhy: Clear spelling typo in user-facing module documentation.
6.
currnettypo 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.
recomendedtypo 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
configrationwithconfigurationin all 3 autodiscover docs listed above.not filewithno filein all 4 Filebeat reference/config doc occurrences listed above.realtivewithrelativein all 3 Heartbeat field-description occurrences.endpontswithendpointsin all 3 O365 docs occurrences.formatedwithformattedin all 3 CrowdStrike docs occurrences.currnetwithcurrentin all 3 DHCPv4 field-description occurrences.recomendedwithrecommendedin all 3 O365 docs occurrences.What is this? | From workflow: Text Auditor
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.
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.