Skip to content

Copy edit custom component documentation #8490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Copy edit custom component documentation #8490

wants to merge 2 commits into from
+96 −86

Conversation

@ANAMASGARD
Copy link

@ANAMASGARD ANAMASGARD commented Nov 22, 2025

Description

This PR addresses issue #8362 by copy editing the custom component documentation pages for style guide compliance and improved clarity.

Changes Made

Style Guide Compliance

  • Applied sentence case to all headings (e.g., "Setting Up" → "Setting up")
  • Capitalized OpenTelemetry proper nouns correctly (Collector vs. collector)
  • Replaced Latin abbreviations with plain English ("e.g." → "for example", "i.e." → "in other words")
  • Converted old Markdown note blocks to Hugo shortcode admonitions ({{% alert title="Note" %}})

Grammar and Clarity Improvements

  • Removed unnecessary passive voice constructions
  • Changed future tense to present tense where appropriate
  • Simplified wordy phrases ("In order to" → "To")
  • Improved sentence flow and readability
  • Fixed punctuation and minor grammar issues

Testing

  • ✅ Ran npm run check:markdown - All tests passed (0 errors)
  • ✅ Verified all style guide requirements met

Below is the screenshot of it :-
Screenshot From 2025-11-22 14-33-34

FIXES #8362

@ANAMASGARD
Copy edit custom component documentation
2d3a21a 
- Apply sentence case to all headings
- Replace Latin abbreviations with plain English
- Convert Markdown notes to Hugo shortcode admonitions
- Remove unnecessary passive voice and future tense
- Improve clarity, grammar, and punctuation
- Fix capitalization per style guide

Fixes open-telemetry#8362
@ANAMASGARD ANAMASGARD requested a review from a team as a code owner November 22, 2025 09:04
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Nov 22, 2025 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: ANAMASGARD / name: Gauarv Chaudhary (e97c2ba)

@otelbot-docs otelbot-docs bot requested review from a team and jmacd and removed request for a team November 22, 2025 09:05
@otelbot-docs otelbot-docs bot requested a review from a team November 23, 2025 11:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jmacd jmacd Awaiting requested review from jmacd jmacd was automatically assigned from open-telemetry/collector-approvers

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

sig:collector

Projects

SIG Comms: PRs & Issues
Status: No status

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[otelcol docs] Copy edit the custom component pages

1 participant

@ANAMASGARD