Update ConfigWatcher-related properties in docs

kubeshop · Oct 4, 2023 · 4423118 · 4423118
1 parent ed98a2d
commit 4423118
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 7 deletions.
diff --git a/docs/configuration/general.md b/docs/configuration/general.md
@@ -24,14 +24,11 @@ settings:
     # If true, disable ANSI colors in logging. Ignored when `json` formatter is used.
     disableColors: false
 
-# Parameters for the Config Watcher container.
-# It watches for data changes of any ConfigMap or Secret with the label `botkube.io/config-watch: "true"` from the namespace where Botkube is installed, and restarts Botkube.
+# Parameters for the Config Watcher component which reloads Botkube on ConfigMap changes.
+# It restarts Botkube when configuration data change is detected. It watches ConfigMaps and/or Secrets with the `botkube.io/config-watch: "true"` label from the namespace where Botkube is installed.
 configWatcher:
   # If true, restarts the Botkube Pod on config changes.
   enabled: true
-  # Timeout for the initial Config Watcher sync.
-  # If set to 0, waiting for Config Watcher sync will be skipped. In a result, configuration changes may not reload Botkube app during the first few seconds after Botkube startup.
-  initialSyncTimeout: 0
 ```
 
 The default configuration for Helm chart can be found in the [values.yaml](https://github.com/kubeshop/botkube/blob/main/helm/botkube/values.yaml) file.
diff --git a/docs/configuration/index.mdx b/docs/configuration/index.mdx
@@ -166,7 +166,6 @@ Botkube allows you to split individual settings into multiple configuration file
   # a.yaml - first file
   settings:
     clusterName: dev-cluster
-    configWatcher: true
     kubectl:
       enabled: false
   ```
@@ -188,7 +187,6 @@ Botkube allows you to split individual settings into multiple configuration file
   # result
   settings:
     clusterName: demo-cluster
-    configWatcher: true
     kubectl:
       enabled: true
   ```