You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rocketmq.apache.org by "Frun1na (via GitHub)" <gi...@apache.org> on 2026/10/01 15:20:53 UTC
[PR] docs: sync README_zh.md with README.md [rocketmq-dashboard]
Frun1na opened a new pull request, #5267:
URL: https://github.com/apache/rocketmq-dashboard/pull/5267
### Which Issue(s) This PR Fixes
None — a trivial documentation sync, which the doc template exempts from needing an issue. It follows
the doc template's rule to keep `README.md` and `README_zh.md` in sync.
### Brief Description
Two statements existed only in the English README:
- **Quick Start.** The note that the default schema seeds no instances / topics / consumer groups /
ACL records, and that the demo data under `deploy/mysql/` (`upgrade-demo-instance.sql` then
`upgrade-demo-acl.sql`) is an explicit, idempotent sample-data load that must never run against a
production database. The Chinese README jumped straight from "visit http://127.0.0.1:6789" to the
ports, so a Chinese-only reader missed the sample-data caveat entirely.
- **Features, Clusters row.** NameServer configuration drift detection was listed in English but
missing in Chinese. The feature exists — `NameServerConfigDiffService` /
`NameServerConfigDiffVO` under `server/src/main/java/org/apache/rocketmq/studio/cluster/nameserver/`.
Everything else in the two files was compared section by section (Quick Start, Screenshots, Features,
AI Assistant, Tech Stack, Development Guidelines) and is already in sync.
### How Did You Test This Change?
Documentation only. The two READMEs were compared section by section, and the one claimed-but-missing
feature was verified against the code:
```
$ git grep -il "drift" upstream/rocketmq-studio -- server/src/main/java
.../cluster/nameserver/NameServerConfigDiffService.java
.../cluster/nameserver/NameServerConfigDiffVO.java
.../cluster/broker/BrokerConfigDiffService.java
```
The demo-data wording mirrors `deploy/README.md`, which already documents the same import order and
the "sample loaders, not upgrade migrations" caveat for the same two scripts.
### Checklist
- [x] One coherent change; unrelated modifications are not bundled in
- [x] Commit subject follows Conventional Commits (`docs:`)
- [ ] Tests added or updated for non-trivial changes, test methods named `...Test`
- [ ] New UI text has both Chinese and English entries under `web/src/i18n/`
- [ ] Architecture constraints stay green (`mvn test` runs the ArchUnit checks)
- [ ] New source files carry the ASF license header
- [x] Documentation touched where behaviour changed (README / `docs/` / in-app help)
---
Re-submission of #4764: the original PR was closed by the stale bot after 7 days without review activity, and GitHub now rejects reopening pull requests in this repository ("state cannot be changed"), so the same change is re-submitted rebased onto the current `rocketmq-studio` tip (`a460673f`). The original review thread stays available at #4764.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@rocketmq.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: sync README_zh.md with README.md [rocketmq-dashboard]
Posted by "lizhimins (via GitHub)" <gi...@apache.org>.
lizhimins merged PR #5267:
URL: https://github.com/apache/rocketmq-dashboard/pull/5267
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@rocketmq.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: sync README_zh.md with README.md [rocketmq-dashboard]
Posted by "Frun1na (via GitHub)" <gi...@apache.org>.
Frun1na commented on PR #5267:
URL: https://github.com/apache/rocketmq-dashboard/pull/5267#issuecomment-6044102734
Friendly ping — this is still open for review whenever you get a chance. (Keeping it from the stale bot for now.)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@rocketmq.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org