Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Default Construct ID documentation #381

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mitchlloyd
Copy link

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:

  • Examples in all supported languages
  • Remove all hard wrapping

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@ghost
Copy link

ghost commented Sep 21, 2022

This is a good contribution and a valuable topic. I appreciate your patience; I know you contributed it a long time ago. Just wanted you to know I've had a look and will try to get to it soon.

@ghost
Copy link

ghost commented Nov 25, 2022

This is a great contribution! It will need the code examples in the other supported languages before it can be merged. We can do this, but it'll probably be a while longer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant