Fix typos in autodiscover/module docs and field descriptions#49504
Fix typos in autodiscover/module docs and field descriptions#49504
Conversation
|
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>
Vale Linting ResultsSummary: 1 warning, 1 suggestion found
|
| 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.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (19)
📝 WalkthroughWalkthroughThis 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)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
TL;DR
Remediation
Investigation detailsRoot CauseThe workflow’s Evidence
Validation
Follow-upIf the regenerated diff in What is this? | From workflow: PR Actions Detective Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not. |
efd6
left a comment
There was a problem hiding this comment.
crowdstrike and o365 changes LGTM
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.