-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Improving readability and tone by removing superfluous terms #5160
Conversation
@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. |
we wanted flying cars instead we got gpu credits being set on fire to do half baked style linting |
@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 |
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. |
There was a problem hiding this 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 |
There was a problem hiding this comment.
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.
Closing out old PR |
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