docs improvment

fivexl · Aug 24, 2023 · 800613b · 800613b
1 parent cf0c58e
commit 800613b
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 9 deletions.
diff --git a/examples/complete_exapmle/main.tf b/examples/complete_exapmle/main.tf
@@ -5,14 +5,13 @@ locals {
       "prod-alerts" = "PPOIUYTREWQ"
     }
   }
-  # Both SNS topic ARN and email addresses can be used as subscribers, but at least one of them is required
   budget_subscriber_email_addresses = [
     "[email protected]",
   ]
   prod_sns_topic_arn = [aws_sns_topic.prod_chatbot.arn]
 }
 
-# Optional Automatic creation Chatbot IAM role
+# Creation of IAM resources for Chatbot
 module "chatbot_role" {
   source = "./modules/iam"
 }
@@ -24,7 +23,6 @@ module "chatbot_slack_workspace" {
 
   workspace_id = local.slack.workspace_id
 
-  # Here can be placed default_iam_role_arn for Chatbot instead of automatic creation
   default_iam_role_arn = module.chatbot_role.iam_role_arn
 
   # Mapping of topics to channels
@@ -68,10 +66,10 @@ module "budget_alerts" {
 module "eventbridge_alerts" {
   source = "./modules/eventbridge"
 
-  # create_guardduty_findings_rule will create eventbridge rule and send all GuardDuty findings to Slack
+  # It will create eventbridge rule and send all GuardDuty findings to Slack
   create_guardduty_findings_rule = true
 
-  # create_aws_health_rule will create eventbridge rule and send all AWS Health events to Slack
+  # Same for AWS Health events
   create_aws_health_rule = true
 
   sns_topic_arn = local.prod_sns_topic_arn[0]

diff --git a/modules/eventbridge/README.MD b/modules/eventbridge/README.MD
@@ -1,5 +1,5 @@
 # Event brige alerts:
-GuardDuty and AWS health events, both are can be disabled.
+GuardDuty and AWS health events.
 
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

diff --git a/modules/iam/README.MD b/modules/iam/README.MD
@@ -1,4 +1,5 @@
-# Optional automated Iam for Chatbot
+# Iam for Chatbot
+Automated creation of IAM resources for AWS Chatbot.
 
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

diff --git a/modules/reservations/README.MD b/modules/reservations/README.MD
@@ -1,6 +1,6 @@
 # Reservations utilization alert
 
-Like in budget alerts, required only 2 values:
+Required only 2 values:
 - `threshold` - percentage of utilization
 - `subscriber_sns_topic_arns` - sns topic for chatbot
 

diff --git a/modules/savings_plans/README.MD b/modules/savings_plans/README.MD
@@ -1,6 +1,6 @@
 # Savings plans utilization alert
 
-Like in budget alerts, required only 2 values:
+Required only 2 values:
 - `threshold` - percentage of utilization
 - `subscriber_sns_topic_arns` - sns topic for chatbot