Skip to content

[improve][doc] Clarify producer name uniqueness and Key_Shared batching requirements#1093

Merged
lhotari merged 2 commits intoapache:mainfrom
kevin-pan-skydio:kp-update-pulsar-docs-producer-name-key-shared-batching
Mar 17, 2026
Merged

[improve][doc] Clarify producer name uniqueness and Key_Shared batching requirements#1093
lhotari merged 2 commits intoapache:mainfrom
kevin-pan-skydio:kp-update-pulsar-docs-producer-name-key-shared-batching

Conversation

@kevin-pan-skydio
Copy link
Copy Markdown
Contributor

@kevin-pan-skydio kevin-pan-skydio commented Mar 17, 2026

Motivation

While working with Pulsar, I noticed a couple of areas where the docs could be
a bit more explicit to help new users avoid common pitfalls:

  1. Producer name uniqueness — The existing docs mention producer names but
    don't prominently call out that explicitly assigned names must be unique per topic.
    Adding this detail up front can save users some head-scratching.

  2. Key_Shared batching requirement — The docs do cover the need for
    key-based batching with Key_Shared subscriptions, but this information
    lives fairly deep in the section. A brief note near the top of the
    Key_Shared description could help users discover this requirement sooner.

Modifications

  • docs/concepts-messaging.md — Expanded the producer name description in
    the message components table. Added a note near the top of the Key_Shared
    section linking to the existing batching details below.
  • docs/concepts-clients.md — Added a short "Producer naming" subsection
    covering uniqueness, auto-generation, and when explicit names are helpful.
  • docs/client-libraries-producers.md — Added a "Producer naming"
    subsection with code examples (Java, C++, Python) and a note that meaningful
    names help with debugging.
  • docs/client-libraries-consumers.md — Added a brief note at the top of
    the Key_shared consumer section pointing out the producer-side batching
    requirement.

Documentation

  • doc-required

Matching

No code changes. Documentation only.

@kevin-pan-skydio kevin-pan-skydio force-pushed the kp-update-pulsar-docs-producer-name-key-shared-batching branch from 00185f7 to c7577b9 Compare March 17, 2026 06:43
Copy link
Copy Markdown
Member

@lhotari lhotari left a comment

Choose a reason for hiding this comment

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

LGTM, great work @kevin-pan-skydio

@lhotari lhotari merged commit 978f44f into apache:main Mar 17, 2026
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.

2 participants