From 8da27899ea202d8abc3d8b40d45d8ccfcf791f52 Mon Sep 17 00:00:00 2001
From: "Zaiming (Stone) Shi" <zmstone@gmail.com>
Date: Fri, 28 Jan 2022 09:54:12 +0100
Subject: [PATCH] docs: fix override conf note

---
 apps/emqx_conf/etc/emqx_conf.conf | 10 ++++++++--
 apps/emqx_conf/etc/emqx_conf.md   | 15 +++++++++------
 2 files changed, 17 insertions(+), 8 deletions(-)

diff --git a/apps/emqx_conf/etc/emqx_conf.conf b/apps/emqx_conf/etc/emqx_conf.conf
index f9a3bbd94..18af3cad0 100644
--- a/apps/emqx_conf/etc/emqx_conf.conf
+++ b/apps/emqx_conf/etc/emqx_conf.conf
@@ -1,5 +1,11 @@
-## NOTE: The configurations in this file will be overridden by
-## `<path-to-emqx-installation>/data/emqx_overrides.conf`
+## NOTE:
+## Configs in this file might be overridden by:
+## 1. Environment variables which start with 'EMQX_' prefix
+## 2. File {{ platform_data_dir }}/configs/cluster-override.conf
+## 3. File {{ platform_data_dir }}/configs/local-override.conf
+##
+## The *-override.conf files are overwritten at runtime when changes
+## are made from EMQ X dashboard UI, management HTTP API, or CLI.
 
 ##==================================================================
 ## Node
diff --git a/apps/emqx_conf/etc/emqx_conf.md b/apps/emqx_conf/etc/emqx_conf.md
index 75972b7fc..52e1f57a1 100644
--- a/apps/emqx_conf/etc/emqx_conf.md
+++ b/apps/emqx_conf/etc/emqx_conf.md
@@ -9,12 +9,15 @@ From bottom up:
 
 1. Immutable base: `emqx.conf` + `EMQX_` prfixed environment variables.<br>
    Changes in this layer require a full node restart to take effect.
-1. Cluster override: The path of which is configured by `cluster_override_conf_file`.<br>
-   Overrides made from management APIs (or dashboard) for all nodes in the cluster.
-1. Local override: The path of which is configured by `local_override_conf_file`.<br>
-   Special overrides applied to local node.
+1. Cluster overrides: `${data_dir}/cluster-override.conf`
+1. Local node overrides: `${data_dir}/configs/local-override.conf`
 
-For detailed override rules, see [Config overlay rules](#config-overlay-rules).
+Where `${data_dir}` is configurable from `node.data_dir`.
+
+The `*-override.conf` files are overwritten at runtime when changes
+are made from dashboard UI, management HTTP API, or CLI.
+
+For detailed override rules, see [Config Overlay Rules](#config-overlay-rules).
 
 ## Syntax
 
@@ -131,7 +134,7 @@ because the field name is `enable`, not `enabled`.
 
 <strong>NOTE:</strong> Unknown root keys are however silently discarded.
 
-### Config overlay rules
+### Config Overlay Rules
 
 HOCON objects are overlaid, in general: