docs: Update README to indicate that using DD_API_KEY directly is not the recommended approach #55
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.
Description
While reviewing the documentation the other day I noticed that inside a statement intending to inform module users not to use the DD_API_KEY variable, the not was missing. This causes the sentence to read as if it is endorsing the use of the DD_API_KEY variable.
Motivation and Context
Users looking to set up the datadog forwarder using this module may get the wrong impression that placing sensitive values in the Lambda environment variables is the recommended practice.
Breaking Changes
No breaking changes
How Has This Been Tested?
This is not a code or example change. I performed no tests.
examples/*
to demonstrate and validate my change(s)examples/*
projectspre-commit run -a
on my pull request