-
Notifications
You must be signed in to change notification settings - Fork 20
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
(docs) expose configuration attributes for classes in documentation #91
(docs) expose configuration attributes for classes in documentation #91
Conversation
Perhaps the Config concept for DDK deserves its own docs page explaining property precedence in resource factory classes in more detail? I've left out updating any resource factory docstrings as it would be redundant with |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can't think of another way to document these.
To clarify for the user, I suggest:
- Adding a How-To guide explaining how our configuration works in general in the DDK
- Reference this How-To under the
Supported DDK Environment Configuration
line here
What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah I agree we need a better (automated in the perfect world) way to surface all available configuration but this is definitely better than nothing
How-to guide to be added: #98 |
…-configuration-attributes-for-classes-in-documentation
Summary
Adds documentation of available configuration attributes to
BaseStack
andCICDPipelineStack
classes.Relates
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.