Add Default Construct ID documentation #381
Open
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.
Issue #377
This change adds documentation for using the special "Default" construct ID. This issue mentions documenting the use of "Resource" as well, but I've since learned that using "Resource" outside of creating L2 constructs doesn't have any advantages over using "Default". For creating L2 constructs, I believe that the CDK design Guidelines are best suited for the audience doing that type of work.
This documentation includes code examples that will need to be translated into multiple languages if they stay in. I'm holding off on that work and just using Github-style code blocks while iterating on the content. I've also used hard line wraps to make editing easier, but I can remove those.
The paragraph beginning "Using "Default" as a construct ID for is a good choice..." may be controversial.x
TODO:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.