[RUMF-912] 📝 add a warning in the RUM-recorder readme #838
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
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.
Motivation
Some customers seem to use the @datadog/browser-rum-recorder package even if they are not enrolled in our session replay beta.
Note: I tried adding the message as a package.json postinstall/install script, but it doesn't seem to work anymore in recent versions of NPM or yarn. The output is captured by the command and only printed if the script fails.
Changes
Add a clear message to advise them to use the RUM-only package.
Testing
Rendered: https://github.com/DataDog/browser-sdk/blob/e690632632769bc2320b658e320f377e8b921f4e/packages/rum-recorder/README.md#warning
I have gone over the contributing documentation.