问题描述
我在本地测试 config_center/zookeeper sample 时,发现 README 中启动 Zookeeper 的命令不够明确:
docker compose up -d zookeeper
这个命令没有说明应该在哪个目录执行,也没有明确指定 docker-compose.yml 文件路径。对于第一次接触该仓库的用户来说,很容易不知道应该在哪里运行该命令,或者因为当前目录下没有对应的 compose 文件而执行失败。
复现步骤
进入 config_center/zookeeper sample 后,按照 README 执行:
docker compose up -d zookeeper
实际结果
用户需要自行判断该命令依赖哪个 docker-compose.yml,但 README 中没有给出明确说明。如果当前目录没有可用的 compose 文件,命令会失败,或者用户会误以为 sample 自身缺少依赖配置。
预期结果
README 应该明确告诉用户如何启动 Zookeeper,并且命令最好可以直接复制运行。
建议修复方式
建议在 README 中给出更明确的 Zookeeper 启动方式。
在使用使用 docker run的时候:
docker run -d --name zk -p 2181:2181 zookeeper:3.8
或者如果仓库中存在统一的 compose 文件,也建议写成显式路径形式:
docker compose -f docker-compose.yml up -d zookeeper
并说明该命令需要在仓库根目录执行。
影响
这是一个文档可用性问题。sample 代码本身可以正常运行,但 README 对外部依赖启动方式说明不够明确,会增加新用户跑通示例的成本。
如果这个修复方向可以接受,我可以继续提交 PR。
问题描述
我在本地测试 config_center/zookeeper sample 时,发现 README 中启动 Zookeeper 的命令不够明确:
这个命令没有说明应该在哪个目录执行,也没有明确指定 docker-compose.yml 文件路径。对于第一次接触该仓库的用户来说,很容易不知道应该在哪里运行该命令,或者因为当前目录下没有对应的 compose 文件而执行失败。
复现步骤
进入 config_center/zookeeper sample 后,按照 README 执行:
实际结果
用户需要自行判断该命令依赖哪个 docker-compose.yml,但 README 中没有给出明确说明。如果当前目录没有可用的 compose 文件,命令会失败,或者用户会误以为 sample 自身缺少依赖配置。
预期结果
README 应该明确告诉用户如何启动 Zookeeper,并且命令最好可以直接复制运行。
建议修复方式
建议在 README 中给出更明确的 Zookeeper 启动方式。
在使用使用 docker run的时候:
或者如果仓库中存在统一的 compose 文件,也建议写成显式路径形式:
并说明该命令需要在仓库根目录执行。
影响
这是一个文档可用性问题。sample 代码本身可以正常运行,但 README 对外部依赖启动方式说明不够明确,会增加新用户跑通示例的成本。
如果这个修复方向可以接受,我可以继续提交 PR。