docs(kafka): polish ExternallyOwned() section (follow-up to #3062)#3065
Merged
Conversation
Three small follow-ups to the docs added in #3062: - Add the version Badge (6.7) on the section heading, matching the convention every other recent section in this file uses. - Cross-reference the "Topic Creation Options" section just above so Specification() / TopicCreation() / ExternallyOwned() are positioned as the same-spectrum APIs they are. - Document that 'dotnet run -- resources check' is NOT skipped for externally-owned topics — CheckAsync sends a Produce probe to verify each topic, which has an observable consequence users should know before running the command against a host with externally-owned endpoints. No API changes. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This was referenced Jun 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to the docs added in #3062, touching only
docs/guide/messaging/transports/kafka.md(+7, -1).What this PR adds
Three focused improvements to the new "Externally-Owned Topics" section:
Version
<Badge>on the heading — every other section added to this file (5.16, 5.17, 5.18, 5.22, 5.27, 6.0, …) carries one; the new section was missing it. Set to 6.7 as the likely next-minor release that will include Add ExternallyOwned() for Kafka topics to skip auto-provisioning and teardown #3062; happy to retarget to whatever you'd actually like to ship this under — one-word edit.Cross-reference to the Topic Creation Options section just above.
Specification()/TopicCreation()(for topics you do own) andExternallyOwned()(for topics you don't) are the two ends of the same spectrum — the section above already documents the owned side, so a one-sentence pointer ties them together.::: tipcallout aboutresources check—KafkaTopic.CheckAsyncis not skipped for externally-owned topics. It sends a small "ping"Produceprobe to verify reachability, which has observable consequences (requiresProduceaccess on every checked topic; can land a probe message on a topic you don't fully own). The transport-levelKafkaUsage.ConsumeOnlyis the only existing escape hatch. Worth a sentence so users runningresources checkaren't surprised.Whether
CheckAsyncshould skipIsExternallyOwnedtopics is a separate question — I'd be happy to file that as a small follow-up issue if you'd like. Not changing the behaviour in this PR.Why no mdsnippets conversion
kafka.mdconsistently uses inline code blocks rather than mdsnippets (the convention insagas.md,command-line.md,validation.md, etc.). Converting just this one section would create an inconsistency within the file; converting the whole file is its own (much larger) project. Out of scope here.🤖 Generated with Claude Code