Fix duplicated-word typos and awkward CLI help phrase in user-facing text#49335
Fix duplicated-word typos and awkward CLI help phrase in user-facing text#49335
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
|
|
This pull request doesn't have a |
…text Co-authored-by: strawgate <6384545+strawgate@users.noreply.github.com>
Vale Linting ResultsSummary: 5 warnings, 2 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| docs/reference/filebeat/filebeat-input-container.md | 13 | Elastic.DontUse | Don't use 'just'. |
| docs/reference/filebeat/filebeat-input-container.md | 15 | Elastic.DontUse | Don't use 'Please'. |
| docs/reference/filebeat/filebeat-input-container.md | 17 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| docs/reference/filebeat/filebeat-input-log.md | 15 | Elastic.DontUse | Don't use 'Please'. |
| docs/reference/filebeat/filebeat-input-log.md | 17 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
💡 Suggestions (2)
| File | Line | Rule | Message |
|---|---|---|---|
| docs/reference/filebeat/filebeat-input-container.md | 13 | Elastic.WordChoice | Consider using 'deactivated, deselected, hidden, turned off, unavailable' instead of 'disabled', unless the term is in the UI. |
| docs/reference/filebeat/filebeat-input-log.md | 13 | Elastic.WordChoice | Consider using 'deactivated, deselected, hidden, turned off, unavailable' instead of 'disabled', unless the term is in the UI. |
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 (7)
📝 WalkthroughWalkthroughThis pull request addresses seven user-facing text corrections across documentation and CLI help text. Changes include removing duplicate words ("the the" and "of of") in Filebeat and Metricbeat documentation files, capitalizing error messages in export command modules for consistency, and replacing the phrase "by the moment" with "for now" in completion command help text. All modifications are textual adjustments with no functional impact. 🚥 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 |
Fixes several duplicated-word typos and one unidiomatic phrase caught by the text auditor.
the the→theinfilebeat-input-container.md,filebeat-input-log.md,filebeat-input-http_endpoint.mdof of→ofinexported-fields-system.mderror creating file handler→Error creating file handlerinlibbeat/cmd/export/template.goandilm_policy.gofor consistency with adjacent fatal messagesby the moment→for nowinlibbeat/cmd/completion.goOriginal prompt
🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.