kevin-pan-skydio opened a new pull request, #1093:
URL: https://github.com/apache/pulsar-site/pull/1093
## Motivation
Two important operational requirements are not surfaced clearly in the
current docs:
1. **Producer names must be globally unique** — The messaging concepts page
vaguely stated
"the default name is used" without mentioning the uniqueness constraint
or the consequences
of violating it. The producer how-to guide had no mention of naming at
all.
2. **Key_Shared subscriptions require key-based batching** — This
requirement was documented
but buried ~400 lines deep in the Key_Shared section, well past the
algorithm details.
Users reading the Key_Shared introduction could easily miss it.
## Modifications
- **`docs/concepts-messaging.md`** — Updated the message components table to
state that
producer names must be unique across all clusters. Added a `:::caution`
admonition at
the top of the Key_Shared section about the batching requirement.
- **`docs/concepts-clients.md`** — Added a "Producer naming" subsection
explaining the
uniqueness constraint, auto-generation, and the deduplication use case.
- **`docs/client-libraries-producers.md`** — Added a "Producer naming"
subsection with
code examples (Java, C++, Python) and guidance that explicit names aid
debugging.
- **`docs/client-libraries-consumers.md`** — Added a `:::caution` admonition
at the top
of the Key_shared consumer section about the producer-side batching
requirement.
## Documentation
- [ ] `doc-required`
Check the box if this PR changes existing docs or adds new ones.
## Matching
No code changes. Documentation only.
--
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]
