lsq3497 opened a new issue, #10455:
URL: https://github.com/apache/rocketmq/issues/10455

   ### Search before creation
   
   - [x] I had searched in the 
[issues](https://github.com/apache/rocketmq/issues) and found no similar issues.
   
   
   ### Documentation Related
   
   Several documentation inaccuracies were found and fixed across the English 
and Chinese developer guides:
   
   1. **Broker startup log IP mismatch** — Six docs (operation, deployment, and 
IDEA debugging guides in both en/cn) showed sample log output with 
`192.169.1.2` while the surrounding text and README use `192.168.1.2`. 
Corrected to `192.168.1.2` for consistency. (This issue was previously reported 
in #2947 but remained unfixed; tracked again in #10451.)
   
   2. **BrokerContainer config path does not exist** — 
`docs/cn/BrokerContainer.md` referenced 
`distribution/conf/container/broker-container.conf`, which is not in the 
repository. Updated to point to the existing sample at 
`distribution/conf/container/2container-2m-2s/broker-container1.conf`, and 
fixed the startup command accordingly. Also corrected the `BrokerConainer` typo 
to `BrokerContainer` in the doc and sample config comments.
   
   3. **English DefaultMQProducer API reference typos** — Fixed obvious errors: 
`ca quickly` → `can quickly`, `Blow is` → `Below is`, `create a produce` → 
`create a producer`, and `rcpHook` → `rpcHook`. Improved grammar in the class 
introduction paragraph.
   
   4. **Additional fixes** — FAQ links upgraded from `http://` to `https://`; 
example code links updated from `blob/master` to `blob/develop`; corrected 
`upgrade to version 4.x` → `upgrade from version 4.x` in the persistent broker 
ID upgrade guide; fixed several typos in `docs/cn/design.md` (e.g. 
`RomotingCommand`, `550L ms`, `无休止的的信息`).
   
   ### Relationship to existing work
   
   This PR addresses #10451 and overlaps with two open PRs from the same issue 
reporter:
   
   - **#10440** — fixes the broker startup log IP typo (`192.169.1.2` → 
`192.168.1.2`) in 6 docs. This PR includes the same change.
   - **#10449** (draft) — fixes the BrokerContainer config path reference and 
English `DefaultMQProducer` API typos. This PR includes the same changes, plus 
additional fixes not covered by #10449.
   
   **Additional fixes in this PR (not in #10440 or #10449):**
   - Correct `BrokerConainer` → `BrokerContainer` in 
`docs/cn/BrokerContainer.md` and sample config comments
   - Update the BrokerContainer startup command to use the existing sample 
config path
   - Upgrade FAQ links from `http://` to `https://`
   - Update example code links from `blob/master` to `blob/develop` (en + cn 
API reference)
   - Fix `upgrade to version 4.x` → `upgrade from version 4.x` in the 
persistent broker ID upgrade guide
   - Fix several typos in `docs/cn/design.md`
   
   
   
   ### Are you willing to submit PR?
   
   - [x] Yes I am willing to submit a PR!


-- 
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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to