Skip to content

docs: use Docker Compose v2 CLI syntax#6216

Open
paopaoandlingyia wants to merge 1 commit into
QuantumNous:mainfrom
paopaoandlingyia:docs/compose-v2-cli
Open

docs: use Docker Compose v2 CLI syntax#6216
paopaoandlingyia wants to merge 1 commit into
QuantumNous:mainfrom
paopaoandlingyia:docs/compose-v2-cli

Conversation

@paopaoandlingyia

@paopaoandlingyia paopaoandlingyia commented Jul 15, 2026

Copy link
Copy Markdown

📝 变更描述 / Description

将 README 多语言版本、宝塔安装文档以及 docker-compose.yml 快速启动注释中的 docker-compose 命令更新为 Docker Compose V2 使用的 docker compose 写法。

本次仅更新文档中的 CLI 命令,不修改 docker-compose.yml 文件名或 Compose 配置行为。

🚀 变更类型 / Type of change

  • 🐛 Bug 修复 (Bug fix)
  • ✨ 新功能 (New feature)
  • ⚡ 性能优化 / 重构 (Refactor)
  • 📝 文档更新 (Documentation)

🔗 关联任务 / Related Issue

  • N/A

✅ 提交前检查项 / Checklist

  • 人工确认: 我已亲自整理并撰写此描述,没有直接粘贴未经处理的 AI 输出。
  • 非重复提交: 我已搜索现有的 Issues 与 PRs,确认不是重复提交。
  • Bug fix 说明: 本次不是 Bug fix。
  • 变更理解: 我已理解这些更改的工作原理及可能影响。
  • 范围聚焦: 本 PR 未包含任何与当前任务无关的代码改动。
  • 本地验证: 已在本地完成手动验证。
  • 安全合规: 代码中无敏感凭据,且符合项目代码规范。

📸 运行证明 / Proof of Work

执行以下命令验证 Compose 配置:

docker compose config --quiet

<!-- This is an auto-generated comment: release notes by coderabbit.ai -->

## Summary by CodeRabbit

* **Documentation**
  * Updated Docker Compose instructions across English, Chinese, French, and Japanese documentation.
  * Replaced the legacy `docker-compose` command with the modern `docker compose` syntax for starting, updating, and restarting services.
  * Aligned the Quick Start, deployment, and installation examples with current Docker usage.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

@coderabbitai

coderabbitai Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3f5f729a-01e3-4d97-a19b-e45c38702686

📥 Commits

Reviewing files that changed from the base of the PR and between a63364d and 895a6cf.

📒 Files selected for processing (8)
  • README.en.md
  • README.fr.md
  • README.ja.md
  • README.md
  • README.zh_CN.md
  • README.zh_TW.md
  • docker-compose.yml
  • docs/installation/BT.md

Walkthrough

Docker Compose startup and restart examples were updated across localized READMEs, the Compose configuration comment, and installation documentation to use docker compose instead of docker-compose.

Changes

Docker Compose documentation

Layer / File(s) Summary
Localized README commands
README*.md
Quick Start and Docker Compose deployment examples use docker compose up -d in all localized READMEs.
Operational Docker instructions
docker-compose.yml, docs/installation/BT.md
Compose comments and installation restart commands use the space-separated Docker Compose syntax.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: calcium-ion

Poem

A rabbit hops through docs so neat,
Replacing dashes at each beat.
docker compose now leads the way,
In every guide, both night and day.
Carrots cheer the cleaner command!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: updating documentation to use the Docker Compose v2 CLI syntax.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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.

1 participant