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: Update docs to clarify create_role and lambda_role usage #527

Closed

Conversation

victortrac
Copy link

Description

Adds clarification to the README and variables.tf about create_role and lambda_role.

Motivation and Context

The lack of this information in the docs made troubleshooting this module take some time.

Breaking Changes

None.

How Has This Been Tested?

  • I have updated at least one of the examples/* to demonstrate and validate my change(s)
  • I have tested and validated these changes using one or more of the provided examples/* projects
  • I have executed pre-commit run -a on my pull request

@victortrac victortrac changed the title Update docs to clarify create_role and lambda_role usage docs: Update docs to clarify create_role and lambda_role usage Jan 6, 2024
@antonbabenko
Copy link
Member

Such an addition to the explanation is not necessary because if we change the logic of the module (rarely we do it) we need to remember to update the description of the variable. Instead, we should provide good feature coverage with examples.

Copy link

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 12, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants