From 64f69b80be0fe9b81bc0210d1b4502c8c38da7ac Mon Sep 17 00:00:00 2001
From: "George H. Sun" <shk3@users.noreply.github.com>
Date: Sat, 11 Jan 2025 08:54:17 +0800
Subject: [PATCH] Document the internal topic logic for topic enforcer. (#74)

---
 kafka_topic_enforcer/README.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/kafka_topic_enforcer/README.md b/kafka_topic_enforcer/README.md
index 4769efc..ff668eb 100644
--- a/kafka_topic_enforcer/README.md
+++ b/kafka_topic_enforcer/README.md
@@ -8,6 +8,8 @@ Kafka topic enforcer's goal is to automate Kafka topic management & hence remove
 * Applies uniform central control to topics and enforces best practices consistently (aka idiot proofing) 
 * Self service, removed dependency on a human
 * Simple configuration
+* Internal Kafka topics (with a suffix of underscore `_`) are skipped from enforcement. Good for tools like kminion that
+  needs to manage the topics on its own.
 
 If you choose to use Strimzi Kafka operator, this command can also generate Strimzi KafkaTopic CRDs.