diff --git a/dev-aws/kafka-shared/CONTRIBUTING.md b/dev-aws/kafka-shared/CONTRIBUTING.md deleted file mode 120000 index 3b7e943d..00000000 --- a/dev-aws/kafka-shared/CONTRIBUTING.md +++ /dev/null @@ -1 +0,0 @@ -../../prod-aws/kafka-shared/CONTRIBUTING.md \ No newline at end of file diff --git a/prod-aws/kafka-shared/CONTRIBUTING.md b/prod-aws/kafka-shared/CONTRIBUTING.md deleted file mode 100644 index f1a1d1cd..00000000 --- a/prod-aws/kafka-shared/CONTRIBUTING.md +++ /dev/null @@ -1,6 +0,0 @@ -# Contributing guidelines - -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) diff --git a/prod-aws/kafka-shared/README.md b/prod-aws/kafka-shared/README.md index ecc5e658..d5ca359f 100644 --- 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)