Skip to content

[Doc] Fix inaccurate documentation examples and typos #10455

@lsq3497

Description

@lsq3497

Search before creation

  • I had searched in the 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 Operation doc mistake #2947 but remained unfixed; tracked again in [Doc] Fix inaccurate documentation examples and typos #10451.)

  2. BrokerContainer config path does not existdocs/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 quicklycan quickly, Blow isBelow is, create a producecreate a producer, and rcpHookrpcHook. Improved grammar in the class introduction paragraph.

  4. Additional fixes — FAQ links upgraded from http:// to https://; corrected upgrade to version 4.xupgrade 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:

Additional fixes in this PR (not in #10440 or #10449):

  • Correct BrokerConainerBrokerContainer 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://
  • Fix upgrade to version 4.xupgrade 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?

  • Yes I am willing to submit a PR!

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions