Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
muzimu217 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/guide/15-docker-deploy.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
5 changes: 4 additions & 1 deletion docs/guide/15-docker-deploy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down