chore: README: clarify this repo is not to be used by SM end users #71
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
d0ugal
approved these changes
Mar 3, 2025
Co-authored-by: Dougal Matthews <[email protected]>
Merged
mem
reviewed
Mar 3, 2025
| @@ -1,5 +1,8 @@ | |||
| # xk6-sm | |||
|
|
|||
| > [!WARNING] | |||
| > Heads up, Synthetic Monitoring users: You do not need to build or download this. A k6 binary compiled with this extension is already shipped in our [agent](https://github.com/grafana/synthetic-monitoring-agent) packages. | |||
There was a problem hiding this comment.
The tone of the message is unnecessarily adversarial.
You can get the same result by simply stating that the code found in this repo is delivered as part of the packages that are available for download as part of the agent releases.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We've seen at least one instance of a customer mistakenly thinking they need to download and install this extension, or the binaries provided. This is not the case, the k6 binary with the appropriate extensions is already packaged in all our agent distributables (container image and linux distro packages).
This adds a fancy looking warning box that should help clarify that in case anyone ends up in this repo.