Skip to content
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

docs(builder): update configuration parameter from 'otelcol_version' to 'version' #6115

Closed
wants to merge 2 commits into from
Closed

docs(builder): update configuration parameter from 'otelcol_version' to 'version' #6115

wants to merge 2 commits into from

Conversation

ezeqme
Copy link

@ezeqme ezeqme commented Jan 30, 2025

Description

Updates documentation to reflect the removal of the otelcol_version parameter and its replacement with version in the OpenTelemetry Collector Builder configuration.

Changes

  • All references to otelcol_version have been replaced with version in the documentation
  • Updated examples to showcase the new parameter name

Breaking Change

⚠️ This is a breaking change. Users will need to update their builder configuration files to use version instead of otelcol_version in newer builder version.

Before:

otelcol_version: 0.118.0

After:

version: 0.118.0

Motivation

This change aligns with our effort to maintain consistent parameter naming across the project and reduces confusion by using a more straightforward parameter name.

Testing

  • Verified all documentation examples are updated
  • Confirmed the new parameter works as expected in new collector builder version

Additional context:

Related Issues

@ezeqme
docs(builder): update configuration parameter from otelcol_version to…
b81311d 
… version

Updates documentation to reflect the parameter name change in OpenTelemetry Collector Builder
from otelcol_version to version for better consistency.
@ezeqme ezeqme requested a review from a team as a code owner January 30, 2025 05:22
@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link

linux-foundation-easycla bot commented Jan 30, 2025 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

@opentelemetrybot opentelemetrybot requested review from a team and evan-bradley and removed request for a team January 30, 2025 05:22
@svrnm
Copy link
Member

svrnm commented Jan 30, 2025

@open-telemetry/collector-approvers PTAL

@opentelemetrybot opentelemetrybot requested a review from a team January 30, 2025 15:51
chalin
chalin approved these changes Jan 30, 2025
View reviewed changes
Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ezeqme ezeqme closed this Jan 30, 2025
@ezeqme ezeqme deleted the update_collector_build_doc branch January 30, 2025 17:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mx-psi mx-psi mx-psi left review comments

@chalin chalin chalin approved these changes

@svrnm svrnm svrnm approved these changes

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

Assignees
No one assigned
Labels
sig:collector
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ezeqme @svrnm @chalin @mx-psi