Kafka Integration - #596
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR significantly expands the Kafka Integration documentation for the ThingsBoard docs site by turning the Kafka page into a full end-to-end guide (setup, uplink converter, testing, downlink via Kafka Rule Node, and troubleshooting), and refreshes the page metadata plus adds a new architecture diagram asset.
Changes:
- Updated Kafka Integration page descriptions (CE/PE/Cloud) to reflect both uplink consumption and downlink publishing via Kafka Rule Node.
- Rewrote the shared Kafka integration include to add architecture, Kafka (KRaft) setup, detailed integration/converter setup steps, downlink configuration/testing, and troubleshooting.
- Added a new Kafka integration architecture SVG and updated the page to reference it.
Reviewed changes
Copilot reviewed 5 out of 36 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/content/docs/docs/user-guide/integrations/kafka.mdx | Updates page description to include downlink publishing via Kafka Rule Node. |
| src/content/docs/docs/pe/user-guide/integrations/kafka.mdx | Same description update for PE docs variant. |
| src/content/docs/docs/paas/user-guide/integrations/kafka.mdx | Same description update for Cloud docs variant. |
| src/content/docs/docs/paas/eu/user-guide/integrations/kafka.mdx | Same description update for Cloud (EU) docs variant. |
| src/content/_includes/docs/user-guide/integrations/kafka.mdx | Major content expansion: architecture, prerequisites, broker setup, converter/integration steps, testing, downlink, troubleshooting, and updated media references. |
| src/assets/images/user-guide/integrations/kafka-integration-architecture.svg | Adds new architecture diagram referenced by the updated Kafka integration page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Description
Type of change
src/content/docs/**)src/content/_includes/**)src/components/**,src/styles/**)src/pages/**,src/data/**)src/data/redirects.ts)releaseskill)Affected products
Related issues
Checklist
pnpm checkpasses (Astro / TypeScript)pnpm lint:eslintpassespnpm lint:slugcheckpasses (required if pages were added/renamed/moved across languages)pnpm lint:linkcheckpasses locally — required to merge; run it before requesting review (usepnpm lint:linkcheck:nobuildif you already ran a build)src/data/redirects.ts, andpnpm generate:redirectswas runsrc/data/versions.ts