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: fix typos and description #719

Merged
merged 2 commits into from
Oct 5, 2023
Merged

Conversation

pdecat
Copy link
Contributor

@pdecat pdecat commented Sep 20, 2023

  • docs(typo): Fix TDP => TCP
  • docs(acm): Fix title of ACM certificates expiration control

Checklist

  • Issue(s) linked

@@ -5,7 +5,7 @@ locals {
}

control "acm_certificate_expires_30_days" {
title = "ACM certificates should be set to expire within 30 days"
title = "ACM certificates should not expire within 30 days"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

@pdecat - We derived this from AWS Config rule, the language was adjusted based on its description.
IMO, AWS has lowered further to 14 days as default from 30 days; we need to revalidate and adjust this query.

CC @khushboo9024

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I guess it is just a matter of wording then.
Given the original description:

The rule is NON_COMPLIANT if your certificates are about to expire.

What about :

Suggested change
title = "ACM certificates should not expire within 30 days"
title = "ACM certificates will expire within 30 days"

Copy link
Contributor

Choose a reason for hiding this comment

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

Usually our titles describe the OK/good state, e.g., CloudFormation stacks outputs should not have any secrets, SQS queues should be configured with a dead-letter queue. So in this case, I think "ACM certificates should not expire within 30 days" is a better title.

@cbruno10 cbruno10 changed the base branch from main to release/v0.75 September 20, 2023 17:27
@cbruno10 cbruno10 changed the base branch from release/v0.75 to release/v0.81 October 5, 2023 14:31
@cbruno10 cbruno10 merged commit dced55e into turbot:release/v0.81 Oct 5, 2023
@cbruno10
Copy link
Contributor

cbruno10 commented Oct 5, 2023

Thanks @pdecat for the fixes! We'll release this in our next version most likely sometime next week.

@misraved misraved added the hacktoberfest-accepted This pull request has been accepted for Hacktoberfest label Oct 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest-accepted This pull request has been accepted for Hacktoberfest
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants