Skip to content

docs: fix stale 1c_2d_cluster references and pgxc_ctl.conf typo - #61

Open
muzimu217 wants to merge 1 commit into
OpenTenBase:mainfrom
muzimu217:fix/issue-203-docker-guide
Open

muzimu217 wants to merge 1 commit into
OpenTenBase:mainfrom
muzimu217:fix/issue-203-docker-guide

Conversation

@muzimu217

Copy link
Copy Markdown

修复内容

Docker 部署指南(docs/guide/15-docker-deploy.md 与 15-docker-deploy.en.md)存在两处与当前主仓 master 分支不符的问题:

  1. 过期的 example/1c_2d_cluster 引用example/1c_2d_cluster 示例目录已从 OpenTenBase/OpenTenBase master 分支移除(commit aca7e2c)。在两份指南的对应小节添加提示说明,指出该步骤仅适用于仍包含该目录的旧版本源码,并引导最新代码的用户参考 Quick Start 中基于 opentenbase_ctl 的部署流程。

  2. 配置文件名笔误deploy all 步骤注释中写的 pgxc.conf 实际应为 pgxc_ctl.conf。依据:主仓 contrib/pgxc_ctl/pgxc_ctl.hDEFAULT_CONF_FILE_NAME 定义为 "pgxc_ctl.conf"

修改范围

2 个文件,+8/−2 行,中英文文档同步修改。

Fixes OpenTenBase/OpenTenBase#203

- 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>
@CLAassistant

CLAassistant commented Sep 10, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Clarify Docker 1C2D example path and pgxc configuration filename

2 participants