docs: move contributing guidelines to README.md

utilitywarehouse · Feb 14, 2024 · 88e20a1 · 88e20a1
1 parent cb3e67a
commit 88e20a1
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 9 deletions.
diff --git a/dev-aws/kafka-shared/CONTRIBUTING.md b/dev-aws/kafka-shared/CONTRIBUTING.md
diff --git a/prod-aws/kafka-shared/CONTRIBUTING.md b/prod-aws/kafka-shared/CONTRIBUTING.md
diff --git a/prod-aws/kafka-shared/README.md b/prod-aws/kafka-shared/README.md
@@ -7,8 +7,11 @@ Use the [tls-app](../../modules/tls-app) module for granting access for the apps
 
 ## Contributing
 
-See [guidelines](CONTRIBUTING.md)
+Please follow these guidelines for the resources:
+1. topic and consumer groups naming: prefix the names with the name of your team. Examples: **bex.internal.bill_fulfilled**, **bex.bills-total-api-reader** where **bex** is the name of the team.
+   This will make it easier to define access in the kafka-ui ([dev](https://kafka-ui.dev.merit.uw.systems/) and [prod](https://kafka-ui.prod.merit.uw.systems/) )
+2. consider the number of partitions for a topic. In Amazon MSK the total number of partitions influences the cost. See [RFC](https://wiki.uw.systems/posts/amazon-msk-managed-kafka-9kjst9t5#h97za-msk)
 
-## Debugging terraform locally
+## pubsub admins: debugging terraform locally
 
 See [instructions](TERRAFORM_LOCALLY.md)