Skip to content

docs: explain the v13 component hierarchy and migration - #723

Open
disrupted wants to merge 2 commits into
refactor/component-hierarchyfrom
docs/v13-component-migration
Open

disrupted wants to merge 2 commits into
refactor/component-hierarchyfrom
docs/v13-component-migration

Conversation

@disrupted

@disrupted disrupted commented Oct 28, 2026 •

Copy link
Copy Markdown
Member

Update component examples and inheritance diagrams to match the new hierarchy.

@disrupted
disrupted requested a review from tobbber as a code owner October 28, 2026 08:46
@disrupted
disrupted added this pull request to stack #725 October 28, 2026 08:46
@disrupted disrupted changed the title docs: document v13 component hierarchy and migration docs: explain the v13 component hierarchy and migration Oct 28, 2026
@tobbber
tobbber requested a balanced review from Copilot October 28, 2026 10:27

Copilot 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.

🟡 Changes recommended

Missing regression assertions for capability-based section selection across component types and both include_inherited modes leave the new from/to ownership rules unverified.

1 open issue
What changed in this PR

Updates KPOps documentation and generated examples to reflect the v13 component hierarchy and topic capabilities.

Changes:

  • Adds a v12-to-v13 migration guide covering validation, defaults, and custom component changes.
  • Updates documentation generation to resolve capability bases and select supported topic sections.
  • Refreshes YAML examples, dependency metadata, and inheritance documentation.
File Description
hooks/​gen_docs/​gen_docs_components.py Resolves capability bases and topic-section ownership.
docs/​mkdocs.yml Adds migration-guide navigation.
docs/​docs/​user/​migration-guide/​v12-v13.md Documents v13 migration requirements.
docs/​docs/​user/​core-concepts/​components/​streams-bootstrap.md Documents both base classes.
docs/​docs/​user/​core-concepts/​components/​helm-app.md Explains topic capabilities for custom Helm components.
docs/​docs/​resources/​pipeline-defaults/​headers/​defaults-streams-app.yaml Corrects the parent-class comment.
docs/​docs/​resources/​pipeline-defaults/​headers/​defaults-producer-app.yaml Corrects the parent-class comment.
docs/​docs/​resources/​pipeline-defaults/​headers/​defaults-kafka-connector.yaml Identifies KafkaApp as the parent in comments.
docs/​docs/​resources/​pipeline-defaults/​headers/​defaults-kafka-app.yaml Corrects inheritance comments.
docs/​docs/​resources/​pipeline-defaults/​headers/​defaults-helm-app.yaml Corrects the child-class comment.
docs/​docs/​resources/​pipeline-defaults/​headers/​defaults-consumer-producer-app.yaml Corrects the parent-class comment.
docs/​docs/​resources/​pipeline-defaults/​headers/​defaults-consumer-app.yaml Corrects the parent-class comment.
docs/​docs/​resources/​pipeline-defaults/​defaults.yaml Refreshes combined defaults and topic ownership.
docs/​docs/​resources/​pipeline-defaults/​defaults-streams-app.yaml Adds supported input and output defaults.
docs/​docs/​resources/​pipeline-defaults/​defaults-producer-app.yaml Adds output defaults and removes obsolete comments.
docs/​docs/​resources/​pipeline-defaults/​defaults-kubernetes-app.yaml Removes unsupported topic defaults.
docs/​docs/​resources/​pipeline-defaults/​defaults-kafka-source-connector.yaml Removes obsolete input-section comments.
docs/​docs/​resources/​pipeline-defaults/​defaults-kafka-sink-connector.yaml Adds sink-specific input defaults.
docs/​docs/​resources/​pipeline-defaults/​defaults-kafka-connector.yaml Removes inherited prefix and unsupported input examples.
docs/​docs/​resources/​pipeline-defaults/​defaults-kafka-app.yaml Removes topic defaults and corrects hierarchy comments.
docs/​docs/​resources/​pipeline-defaults/​defaults-helm-app.yaml Corrects the child-class comment.
docs/​docs/​resources/​pipeline-defaults/​defaults-consumer-producer-app.yaml Adds input and output defaults.
docs/​docs/​resources/​pipeline-defaults/​defaults-consumer-app.yaml Adds input defaults and removes obsolete comments.
docs/​docs/​resources/​pipeline-components/​streams-app.yaml Reorders supported topic sections.
docs/​docs/​resources/​pipeline-components/​sections/​to-consumer-app.yaml Removes the obsolete output placeholder.
docs/​docs/​resources/​pipeline-components/​sections/​from_-producer-app.yaml Removes the obsolete input placeholder.
docs/​docs/​resources/​pipeline-components/​sections/​from_-kafka-source-connector.yaml Removes the obsolete input placeholder.
docs/​docs/​resources/​pipeline-components/​producer-app.yaml Reorders outputs and removes obsolete comments.
docs/​docs/​resources/​pipeline-components/​pipeline.yaml Refreshes the combined component examples.
docs/​docs/​resources/​pipeline-components/​kubernetes-app.yaml Removes unsupported topic sections.
docs/​docs/​resources/​pipeline-components/​kafka-source-connector.yaml Removes obsolete input-section comments.
docs/​docs/​resources/​pipeline-components/​kafka-sink-connector.yaml Reorders the input section.
docs/​docs/​resources/​pipeline-components/​kafka-connector.yaml Removes the unsupported input section.
docs/​docs/​resources/​pipeline-components/​kafka-app.yaml Removes unsupported topic sections.
docs/​docs/​resources/​pipeline-components/​helm-app.yaml Removes unsupported topic sections.
docs/​docs/​resources/​pipeline-components/​dependencies/​pipeline_component_dependencies.yaml Updates component template dependencies.
docs/​docs/​resources/​pipeline-components/​dependencies/​kpops_structure.yaml Refreshes field and inheritance metadata.
docs/​docs/​resources/​pipeline-components/​dependencies/​defaults_pipeline_component_dependencies.yaml Updates defaults template dependencies.
docs/​docs/​resources/​pipeline-components/​consumer-producer-app.yaml Reorders supported topic sections.
docs/​docs/​resources/​pipeline-components/​consumer-app.yaml Reorders inputs and removes obsolete comments.
docs/​docs/​resources/​architecture/​components-hierarchy.md Updates the component inheritance diagram.

Review effort: Balanced

Comment on lines +156 to +159
if has_direct_capability_field(registry[component_name], target_section):
section = target_section + ".yaml"
if section in sections:
return section

This branch has not been deployed

No deployments
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.

3 participants