chore: Refactor README to prepare for adding step function doc #334
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
lym953
commented
Nov 19, 2024
Comment on lines
+64
to
+66
| ##### Note: | ||
|
|
||
| Pay attention to the output from your package manager as the `Datadog CDK Construct Library` has peer dependencies. |
There was a problem hiding this comment.
Moving it up to the PyPI section, where it's supposed to be, as shown in the original PR #28.
|
|
||
| - _If you are new to AWS CDK then check out this [workshop][14]._ |
There was a problem hiding this comment.
Moving this to Resources to learn about CDK section
| @@ -85,7 +88,7 @@ Add this to your CDK stack: | |||
| ```typescript | |||
| import { DatadogLambda } from "datadog-cdk-constructs-v2"; | |||
|
|
|||
| const datadog = new DatadogLambda(this, "Datadog", { | |||
| const datadogLambda = new DatadogLambda(this, "datadogLambda", { | |||
There was a problem hiding this comment.
datadogLambda is the preferred variable name now because we will soon add datadogSfn for Ste pFunctions. Using datadog will cause confusion.
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.
What does this PR do?
Lambdabecause I'll soon add aStep Functionsection.Motivation
Testing Guidelines
Additional Notes
Types of Changes
Check all that apply