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

(docs) expose configuration attributes for classes in documentation #91

Conversation

malachi-constant
Copy link
Contributor

@malachi-constant malachi-constant commented Apr 13, 2022

Summary

Adds documentation of available configuration attributes to BaseStack and CICDPipelineStack classes.

Relates

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@malachi-constant malachi-constant self-assigned this Apr 13, 2022
@malachi-constant malachi-constant marked this pull request as draft April 13, 2022 01:36
@malachi-constant malachi-constant marked this pull request as ready for review April 13, 2022 17:30
@malachi-constant
Copy link
Contributor Author

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 Parameters

Copy link
Contributor

@jaidisido jaidisido left a 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:

  1. Adding a How-To guide explaining how our configuration works in general in the DDK
  2. Reference this How-To under the Supported DDK Environment Configuration line here

What do you think?

Copy link
Contributor

@kukushking kukushking left a 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

@malachi-constant
Copy link
Contributor Author

How-to guide to be added: #98

@malachi-constant malachi-constant added this to the 0.4.0 milestone Apr 18, 2022
@malachi-constant malachi-constant merged commit d455141 into main Apr 19, 2022
@jaidisido jaidisido deleted the 88-docs-expose-configuration-attributes-for-classes-in-documentation branch April 19, 2022 14:54
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.

(docs) expose configuration attributes for classes in documentation
3 participants