From 442952697ee36a47971769f5f06218e322689d10 Mon Sep 17 00:00:00 2001
From: muzimu217 <1278844978@qq.com>
Date: Wed, 9 Sep 2026 23:29:30 -0700
Subject: [PATCH] docs: fix stale 1c_2d_cluster references and pgxc_ctl.conf
 typo

- Add a note that the example/1c_2d_cluster directory was removed from
  the master branch of OpenTenBase/OpenTenBase (commit aca7e2c) and
  point readers to the opentenbase_ctl based Quick Start flow instead
- Fix the pgxc.conf typo: the config file used by 'deploy all' is
  pgxc_ctl.conf, matching DEFAULT_CONF_FILE_NAME in
  contrib/pgxc_ctl/pgxc_ctl.h

Fixes OpenTenBase/OpenTenBase#203

Signed-off-by: muzimu217 <1278844978@qq.com>
---
 docs/guide/15-docker-deploy.en.md | 5 ++++-
 docs/guide/15-docker-deploy.md    | 5 ++++-
 2 files changed, 8 insertions(+), 2 deletions(-)

diff --git a/docs/guide/15-docker-deploy.en.md b/docs/guide/15-docker-deploy.en.md
index 6eaa187..5ee13a4 100644
--- a/docs/guide/15-docker-deploy.en.md
+++ b/docs/guide/15-docker-deploy.en.md
@@ -13,6 +13,9 @@ cd ${SOURCECODE_PATH}/docker
 Commands above will build `opentenbasebase` and `opentenbase` images.
 
 ## 2.Start the example service and enter the CN contaioner
+
+> **Note**: The `example/1c_2d_cluster` directory has been removed from the `master` branch of the main repository (commit `aca7e2c`, 2025-08-07). The steps below only apply to older source trees that still contain it. For the latest code, follow the `opentenbase_ctl` based deployment flow in the [Quick Start](01-quickstart.en.md) or the main repository README.
+
 ```shell
 cd ${SOURCECODE_PATH}/example/1c_2d_cluster
 docker-compose up -d
@@ -39,7 +42,7 @@ cp ~/pgxc_conf/pgxc_ctl.conf ~/pgxc_ctl
 Use `pgxc_ctl` for deployment. Avoid using commands like `ls` or `echo` after entering `pgxc_ctl`.
 ```shell
 pgxc_ctl                                # This step will enter --home location, which is by default /home/$USER/pgxc_ctl. Type exit to exit or Ctrl + D
-deploy all                              # This will use pgxc.conf located in /home/$USER/pgxc_ctl/pgxc.conf for deployment
+deploy all                              # This will use pgxc_ctl.conf located in /home/$USER/pgxc_ctl/pgxc_ctl.conf for deployment
 init all
 
 exit
diff --git a/docs/guide/15-docker-deploy.md b/docs/guide/15-docker-deploy.md
index e15534a..81351a7 100644
--- a/docs/guide/15-docker-deploy.md
+++ b/docs/guide/15-docker-deploy.md
@@ -13,6 +13,9 @@ cd ${SOURCECODE_PATH}/docker
 上述指令会构建`opentenbasebase`和 `opentenbase`两个镜像。
 
 ## 2.启动 example 服务，进入 opentenbaseCN 容器
+
+> **注意**：`example/1c_2d_cluster` 示例目录已在主仓库 master 分支中移除（commit `aca7e2c`，2025-08-07）。本节步骤仅适用于仍包含该目录的旧版本源码；如使用最新代码，请参考 [Quick Start](01-quickstart.md) 或主仓库 README 中基于 `opentenbase_ctl` 的部署流程。
+
 ```shell
 cd ${SOURCECODE_PATH}/example/1c_2d_cluster
 docker-compose up -d
@@ -39,7 +42,7 @@ cp ~/pgxc_conf/pgxc_ctl.conf ~/pgxc_ctl
 使用 `pgxc_ctl`  进行部署，使用`pgxc_ctl`之后，不要敲 `ls` ,`echo` 这种命令。
 ```shell
 pgxc_ctl                                # 这一步会进入 --home 位置，默认是/home/$USER/pgxc_ctl, 使用exit退出，或者ctrl + D
-deploy all                              # 会使用/home/$USER/pgxc_ctl/pgxc.conf 这个配置文件
+deploy all                              # 会使用/home/$USER/pgxc_ctl/pgxc_ctl.conf 这个配置文件
 init all
 
 exit