Skip to content

Conversation

@bellaguang1216
Copy link

Description

This PR addresses issue #8354 by copy editing the Collector installation page (/docs/collector/installation/) to improve clarity, grammar, and style guide compliance.

Style Guide Compliance

  • Sentence case subheadings: Changed "DEB Installation" and "RPM Installation" to sentence case ("DEB installation", "RPM installation")
  • Proper noun capitalization: Fixed "daemonset" → "DaemonSet"
  • Shortcode admonitions: Replaced Markdown note (> Note:) with shortcode admonition ({{% alert title="Note" %}})
  • Serial comma: Added serial comma in "APK, DEB, and RPM"

Grammar Fixes

  • Fixed "a different settings" → "different settings"
  • Added missing commas after introductory phrases ("Debian systems run" → "Debian systems, run")
  • Changed "and as full demo" → "or full demo" for better grammar

Clarity and Active Voice Improvements

  • Reduced passive voice throughout (e.g., "The previous example is meant to serve" → "This example serves")
  • Simplified instructions by removing unnecessary "You can" phrases (e.g., "You can find" → "Find")
  • Made language more direct and concise (e.g., "the version of the Collector you want to run" → "your desired Collector version")
  • Improved word choice (e.g., "such as" → "including" where appropriate, "that runs after" → "available after")

Additional Improvements

  • Standardized instruction tone throughout the document
  • Maintained consistent present tense
  • Improved flow and readability of technical instructions

All changes maintain the technical accuracy of the content while improving readability and adherence to the project's style guide. The page is ready for review by the Collector SIG for technical accuracy verification as requested in the issue.

Related Issues

Fixes #8354

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Nov 28, 2025

CLA Signed
The committers listed above are authorized under a signed CLA.

  • ✅ login: bellaguang1216 / name: Bella (6989fd3)

@otelbot-docs otelbot-docs bot requested review from a team and mx-psi and removed request for a team November 28, 2025 19:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

[otelcol docs] Copy edit the Collector installation page

1 participant