Skip to content

[Doc] Fix inaccurate documentation examples and typos #10451

@gaoxiaolei-s59

Description

@gaoxiaolei-s59

Search before creation

  • I had searched in the issues and found no similar issues.

Documentation Related

There are several small documentation problems in the current docs:

  1. Broker startup examples in the English and Chinese operation/deployment/debugging docs use 192.169.1.2 in the sample log output, while the surrounding text and README examples use 192.168.1.2.

  2. The BrokerContainer Chinese documentation references distribution/conf/container/broker-container.conf, but that file does not exist in this repository. The existing sample configs are under distribution/conf/container/2container-2m-2s/, such as broker-container1.conf.

  3. The English DefaultMQProducer API reference contains obvious typos, including ca quickly, Blow is, create a produce, and rcpHook.

These issues make the documentation examples less clear and, in the BrokerContainer case, point users to a non-existent config path.

Are you willing to submit PR?

  • Yes I am willing to submit a PR!

Related PRs:

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    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