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
|
…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 ignored due to path filters (1)
📒 Files selected for processing (37)
✅ Files skipped from review due to trivial changes (26)
📝 WalkthroughWalkthroughThis PR applies numerous textual and formatting edits across documentation and CLI help/error strings. Changes include fixing duplicated words and minor typos in many exported-fields and module docs, small formatting cleanup in asciidoc/YAML comments, an added example for HTTP monitor body matching, capitalization of two error messages in libbeat export commands, rewording the completion command help, and a large change that replaces a previously commented Salesforce module template with an active configuration in x-pack/filebeat/filebeat.reference.yml. No code behavior or control-flow changes were made. 🚥 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 |
|
Pinging @elastic/elastic-agent-data-plane (Team:Elastic-Agent-Data-Plane) |
|
Checked workflow run
Root cause analysis: not applicable because the run completed successfully. What is this? | From workflow: PR Actions Detective Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not. |
|
The failure is caused by
Root cause: this PR modifies Recommended minimal fix in this PR:
Tests run by me: log analysis only (no local rerun of CI jobs). What is this? | From workflow: PR Actions Detective Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not. |
|
CI failure is caused by generated docs drift in the
Root cause: the PR changed a generated file directly, but the source string still contains the typo in Recommended fix (minimal):
Tests run by me: none locally; analysis based on failed workflow logs for run What is this? | From workflow: PR Actions Detective Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not. |
|
/ai address PR feedback and check for all user facing duplicate word typos in the codebase and resolve any incorrect usage you find |
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.