Skip to content

docs: fix grammar errors in user-facing reference documentation#49638

Merged
strawgate merged 2 commits intoelastic:mainfrom
strawgate:strawgate/fix-typos-pr8-ingest-docs
Mar 24, 2026
Merged

docs: fix grammar errors in user-facing reference documentation#49638
strawgate merged 2 commits intoelastic:mainfrom
strawgate:strawgate/fix-typos-pr8-ingest-docs

Conversation

@strawgate
Copy link
Copy Markdown
Contributor

Summary

Fix grammar and spelling errors in docs/reference/** documentation files.

  • Fix subject-verb disagreement: the dashboard are loadedthe dashboards are loaded (×5 beats)
  • Fix spelling: piplinespipelines in winlogbeat CLI docs
  • Fix subject-verb disagreement: This settings allowsThis setting allows (×2)
  • Fix participle usage: on configuration theon configuring the in syslog metrics endpoint docs (×6 beats)

These are pure documentation fixes with no source code changes.

Closes #49432

Test plan

  • Verify each changed file shows the corrected text

- Fix subject-verb disagreement: 'dashboard are' → 'dashboards are' (×5)
- Fix spelling: 'piplines' → 'pipelines' in winlogbeat CLI docs
- Fix subject-verb disagreement: 'This settings allows' → 'This setting allows' (×2)
- Fix participle: 'on configuration the' → 'on configuring the' (×6)

Closes elastic#49432
@strawgate strawgate requested a review from a team as a code owner March 24, 2026 18:38
@botelastic botelastic Bot added the needs_team Indicates that the issue/PR needs a Team:* label label Mar 24, 2026
@github-actions
Copy link
Copy Markdown
Contributor

🤖 GitHub comments

Just comment with:

  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 24, 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: b420b2c2-0b3e-426b-b2bf-4795c4228a87

📥 Commits

Reviewing files that changed from the base of the PR and between 884e58d and 71df918.

📒 Files selected for processing (15)
  • changelog/fragments/1774377466-fix-typos-docs-ingest.yaml
  • docs/reference/auditbeat/configuration-dashboards.md
  • docs/reference/auditbeat/syslog.md
  • docs/reference/filebeat/configuration-dashboards.md
  • docs/reference/filebeat/filebeat-input-winlog.md
  • docs/reference/filebeat/syslog.md
  • docs/reference/heartbeat/syslog.md
  • docs/reference/metricbeat/configuration-dashboards.md
  • docs/reference/metricbeat/syslog.md
  • docs/reference/packetbeat/configuration-dashboards.md
  • docs/reference/packetbeat/syslog.md
  • docs/reference/winlogbeat/command-line-options.md
  • docs/reference/winlogbeat/configuration-dashboards.md
  • docs/reference/winlogbeat/configuration-winlogbeat-options.md
  • docs/reference/winlogbeat/syslog.md

📝 Walkthrough

Walkthrough

This pull request corrects grammar and spelling errors across user-facing reference documentation. Changes include: fixing subject-verb disagreement in dashboard setup docs ("dashboard are" → "dashboards are"), correcting a spelling typo in CLI documentation ("piplines" → "pipelines"), fixing grammar in configuration option descriptions ("settings" → "setting"), and correcting phrasing in syslog metrics documentation ("configuration the" → "configuring the"). A changelog fragment documents these fixes across multiple beat modules. All modifications are documentation-only without altering configuration behavior or public code entities.

🚥 Pre-merge checks | ✅ 1 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning PR addresses 4 of 5 objective groups: corrects subject-verb disagreement in dashboards (5 files), pipelines typo, settings/setting grammar (2 files), and configuration/configuring phrasing (6 files). SQL module updates are missing. Add corrections to x-pack/metricbeat/module/sql/_meta/docs.md and docs/reference/metricbeat/metricbeat-module-sql.md to complete all linked issue #49432 objectives.
✅ Passed checks (1 passed)
Check name Status Explanation
Out of Scope Changes check ✅ Passed All changes are documentation grammar/spelling fixes directly aligned with linked issue #49432. No unrelated or 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
  • 🛠️ Update Documentation: Commit on current branch
  • 🛠️ Update Documentation: Create PR

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

@strawgate strawgate added Team:Docs Label for the Observability docs team backport-skip Skip notification from the automated backport with mergify labels Mar 24, 2026
@botelastic botelastic Bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Mar 24, 2026
@elastic elastic deleted a comment from mergify Bot Mar 24, 2026
@strawgate strawgate merged commit c262cc2 into elastic:main Mar 24, 2026
22 checks passed
@vishaangelova vishaangelova added backport-9.3 Automated backport to the 9.3 branch and removed backport-skip Skip notification from the automated backport with mergify labels Mar 24, 2026
@vishaangelova
Copy link
Copy Markdown
Member

This needs to be backported to 9.3 for the changes to be published to the docs site (we publish from the latest minor branch).

mergify Bot pushed a commit that referenced this pull request Mar 24, 2026
strawgate added a commit that referenced this pull request Mar 24, 2026
…nce documentation (#49650)

Co-authored-by: Bill Easton <bill.easton@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-9.3 Automated backport to the 9.3 branch 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 grammar and typo errors in user-facing reference docs

3 participants