Repository navigation
Add Kafka functions pointer page - #6773
Conversation
Add a thin Kafka functions page to the functions section that links to the full Kafka functions guide and run.kafka reference in the func repository. This makes the feature discoverable from knative.dev docs while the detailed, versioned documentation stays with the code.
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: aliok The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
✅ Deploy Preview for knative ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
The Kafka functions pointer page was added but not linked from the versioned Functions navigation, so it never appeared in the rendered site (or the deploy preview). Add it to the Functions section so readers can reach it.
Signed-off-by: Ali Ok <aliok@redhat.com>
There was a problem hiding this comment.
🟡 Changes recommended
The Kafka functions documentation overstates deployment support and could lead users to configure functions that the default Knative deployer cannot deploy.
1 open issue
What changed in this PR
Adds a Functions documentation pointer page for Kafka functions, linking to the detailed versioned guidance in the knative/func repository and exposing the page through the Functions navigation.
Changes:
- Added a Kafka functions overview page with links to the full guide and
run.kafkareference. - Added the new page to the versioned Functions navigation.
- The page should clarify that Kafka functions are supported by the
rawandkedadeployers, not the defaultknativedeployer.
| File | Description |
|---|---|
| docs/versioned/functions/kafka-functions.md | Introduces Kafka functions and links to the external guide and run.kafka configuration reference. |
| docs/versioned/.nav.yml | Adds the Kafka functions page to the versioned Functions navigation. |
Review effort: Lite
|
|
||
| # Kafka functions | ||
|
|
||
| A function can consume messages from an Apache Kafka topic. When a function declares a `run.kafka` configuration, `func` deploys a language-agnostic runtime sidecar alongside it. The sidecar consumes the topic and delivers each record to the function as a CloudEvent over HTTP, so the function stays a plain CloudEvents handler in any language, with no Kafka client code of its own. |
|
/lgtm |
|
/unhold |

Adds a "Kafka functions" page to the Functions section that points readers to the full Kafka functions guide in the
knative/funcrepository, where the versioned Functions documentation lives.Proposed Changes
docs/versioned/functions/kafka-functions.md, a thin page describing what a Kafka function is and linking the full Kafka functions guide and therun.kafkareference inknative/func.