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.

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

Improving readability and tone by removing superfluous terms #5160

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

puneet-ekline
Copy link

@puneet-ekline puneet-ekline commented Sep 6, 2024

Description
Avoid words that assume a specific level of understanding
Reference: https://kubernetes.io/docs/contribute/style/style-guide/#avoid-words-that-assume-a-specific-level-of-understanding

More details about EkLine.io here

@puneet-ekline
Copy link
Author

Thanks for the feedback, @shaun-cox and @theletterf. Agree to all of it. Will keep in mind for future PRs :)

@puneet-ekline
Copy link
Author

@austinlparker, These commits were created using EkLine's style guide platform. We imported the Kubernetes and OpenTelemetry style guide onto our platform. This configured the engine to detect adherence issues and recommend improvements to bring the docs in line with style guide standards. Then I applied those suggestions and raised a pull request for them.

@ericmustin
Copy link
Contributor

we wanted flying cars instead we got gpu credits being set on fire to do half baked style linting

@puneet-ekline puneet-ekline changed the title Improving readability and tone by removing condescending phrases Improving readability and tone by removing superfluous terms Sep 9, 2024
@opentelemetrybot opentelemetrybot requested review from a team and evan-bradley and removed request for a team September 10, 2024 05:47
@theletterf
Copy link
Member

@svrnm I'd say let's merge this one?

@svrnm svrnm added the blocked label Sep 11, 2024
@svrnm
Copy link
Member

svrnm commented Sep 11, 2024

@svrnm I'd say let's merge this one?

I think we need to hold back for a while to decide if/how we accept such a PR

@svrnm
Copy link
Member

svrnm commented Sep 13, 2024

Following up on this based on a decision by @open-telemetry/governance-committee and @open-telemetry/technical-committee: we will review / accept / reject this (and #5164) based on their merit, but we do not want to be part of any sales pitch or growth hacking by this tool vendor (ekline) or any other tool vendor.

If we merge this PR we expect OpenTelemetry to not be mentioned in any written or verbal sales or marketing communication.

A pull request to an open source project is not the right place for any sales motion, the advertisement of a tool, and the offering of any (free) licenses we could obtain for it.

Copy link
Member

@svrnm svrnm left a comment

Choose a reason for hiding this comment

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

A few inline comments

You can try out a simple OpAMP setup yourself by using the [OpAMP protocol
You can try out an OpAMP setup yourself by using the [OpAMP protocol
Copy link
Member

Choose a reason for hiding this comment

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

Here the "simple" was more in the sense of "minimal" or "basic", since the setup does not provide a feature richt functionality. A different word may be a better choice.

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.

10 participants