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

fix(examples): make alarm email optional and add README instructions #381

Merged
merged 1 commit into from
Apr 5, 2021

Conversation

jusiskin
Copy link
Contributor

@jusiskin jusiskin commented Apr 5, 2021

Problem

#373 added code in the AWS-All-in-Basic example to allow configuring an email address to which operational alarm notifications are sent. The intention was to have this optional and when not specified, no alarms would be configured. In the TypeScript version of the example, this was not made optional and anyone using it would need to modify the code. This new configuration setting was not documented in the README.md files.

Solution

  • Made the property optional in the TypeScript example
  • Added a step to both the Python and TypeScript README.md to optionally populate this configuration setting

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

@jusiskin jusiskin added documentation This is a problem with documentation. contribution/core This is a PR that came from AWS. labels Apr 5, 2021
Copy link
Contributor

@ddneilson ddneilson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for filling the gap that I left behind, Josh.

@jusiskin jusiskin merged commit 94abd59 into aws:mainline Apr 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS. documentation This is a problem with documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants