Skip to content

fix: Topic creation docs - #1057

Merged
labrenbe merged 3 commits into
mainfrom
fix/kafka-topic-docs
Nov 12, 2026
Merged

labrenbe merged 3 commits into
mainfrom
fix/kafka-topic-docs

Conversation

@labrenbe

@labrenbe labrenbe commented Nov 11, 2026 •

Copy link
Copy Markdown
Member

Description

Part of stackabletech/issues#888

Fix documentation on topic creation:

  • Correctly state that num.partitions of KRaft controller config is used as default (same for replication factor)
  • Recommendation to wait for all brokers to have joined the cluster before creating KafkaTopics

Definition of Done Checklist

  • Not all of these items are applicable to all PRs, the author should update this template to only leave the boxes in that are relevant
  • Please make sure all these things are done and tick the boxes

Author

  • Changes are OpenShift compatible
  • CRD changes approved
  • CRD documentation for all fields, following the style guide.
  • Helm chart can be installed and deployed operator works
  • Integration tests passed (for non trivial changes)
  • Changes need to be "offline" compatible
  • Links to generated (nightly) docs added
  • Release note snippet added

Reviewer

  • Code contains useful comments
  • Code contains useful logging statements
  • (Integration-)Test cases added
  • Documentation added or updated. Follows the style guide.
  • Changelog updated
  • Cargo.toml only contains references to git tags (not specific commits or branches)

Acceptance

  • Feature Tracker has been updated
  • Proper release label has been added
  • Links to generated (nightly) docs added
  • Release note snippet added
  • Add type/deprecation label & add to the deprecation schedule
  • Add type/experimental label & add to the experimental features tracker

@labrenbe
labrenbe requested a review from sbernauer November 11, 2026 16:14
@labrenbe labrenbe self-assigned this Nov 11, 2026
@labrenbe labrenbe moved this to Development: Waiting for Review in Stackable Engineering Nov 11, 2026

@sbernauer sbernauer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM, only minor suggestions

@sbernauer sbernauer moved this from Development: Waiting for Review to Development: In Review in Stackable Engineering Nov 12, 2026
Co-authored-by: Sebastian Bernauer <sebastian.bernauer@stackable.tech>
@labrenbe
labrenbe enabled auto-merge November 12, 2026 09:05
@labrenbe
labrenbe added this pull request to the merge queue Nov 12, 2026
Merged via the queue into main with commit 32345ef Nov 12, 2026
13 checks passed
@labrenbe
labrenbe deleted the fix/kafka-topic-docs branch November 12, 2026 09:14
@labrenbe labrenbe moved this from Development: In Review to Development: Done in Stackable Engineering Nov 12, 2026
@lfrancke lfrancke moved this from Development: Done to Share in Stackable Engineering Nov 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Development

Successfully merging this pull request may close these issues.

3 participants