Skip to content

docs: fix broker container reference and producer typos#10449

Open
gaoxiaolei-s59 wants to merge 1 commit into
apache:developfrom
gaoxiaolei-s59:codex/fix-doc-reference-typos
Open

docs: fix broker container reference and producer typos#10449
gaoxiaolei-s59 wants to merge 1 commit into
apache:developfrom
gaoxiaolei-s59:codex/fix-doc-reference-typos

Conversation

@gaoxiaolei-s59

@gaoxiaolei-s59 gaoxiaolei-s59 commented Jun 9, 2026

Copy link
Copy Markdown

Which Issue(s) This PR Fixes

Fixes #10451

Brief Description

Fix two documentation issues:

  • Update the BrokerContainer doc to reference an existing sample config: distribution/conf/container/2container-2m-2s/broker-container1.conf.
  • Fix obvious typos in the English DefaultMQProducer API reference, including ca quickly, Blow is, create a produce, and rcpHook.

How Did You Test This Change?

  • git diff --check HEAD~1..HEAD
  • rg -n "ca quickly|Blow is|rcpHook|distribution/conf/container/broker-container\.conf|create a produce with" docs/cn/BrokerContainer.md docs/en/client/java/API_Reference_DefaultMQProducer.md || true
  • test -f distribution/conf/container/2container-2m-2s/broker-container1.conf

Documentation-only change.

@RongtongJin RongtongJin left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the fix. Before we move this forward, could you please open a corresponding issue that describes the problem this PR addresses and link it here?

Please also update the PR description to reference that issue, for example with Fixes #<issue-number>. We generally prefer to track even small fixes through a linked issue so the context and rationale are clear.

@gaoxiaolei-s59

Copy link
Copy Markdown
Author

Thanks for the reminder. I opened #10451 to describe the documentation problems and updated this PR description with Fixes #10451.

@gaoxiaolei-s59 gaoxiaolei-s59 marked this pull request as ready for review June 10, 2026 02:49

@oss-sentinel-ai oss-sentinel-ai left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review: Approved ✅

PR: #10449 — docs: fix broker container reference and producer typos
Type: Documentation fix (2 files, +5/-6)

Assessment

Clean documentation fix addressing two issues:

  1. BrokerContainer.md: Updated config file path to reference existing sample broker-container1.conf
  2. API_Reference_DefaultMQProducer.md: Fixed typos (ca quickly, Blow is, create a produce, rcpHook)

Verdict

✅ Straightforward documentation improvement. Fixes #10451.


🤖 Automated review by oss-sentinel-ai

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.

[Doc] Fix inaccurate documentation examples and typos

3 participants