Skip to content

Add Kafka functions pointer page - #6773

Merged
knative-prow[bot] merged 3 commits into
knative:mainfrom
aliok:add-kafka-functions-pointer
Nov 11, 2026
Merged

knative-prow[bot] merged 3 commits into
knative:mainfrom
aliok:add-kafka-functions-pointer

Conversation

@aliok

@aliok aliok commented Nov 6, 2026 •

Copy link
Copy Markdown
Member

Adds a "Kafka functions" page to the Functions section that points readers to the full Kafka functions guide in the knative/func repository, where the versioned Functions documentation lives.

Proposed Changes

  • 📖 Add docs/versioned/functions/kafka-functions.md, a thin page describing what a Kafka function is and linking the full Kafka functions guide and the run.kafka reference in knative/func.
  • 📖 Add the page to the Functions navigation so it renders in the site.

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.
@knative-prow knative-prow Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 6, 2026
@knative-prow

knative-prow Bot commented Nov 6, 2026

Copy link
Copy Markdown

[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

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@knative-prow
knative-prow Bot requested review from Leo6Leo and skonto November 6, 2026 12:03
@knative-prow knative-prow Bot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 6, 2026
@netlify

netlify Bot commented Nov 6, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for knative ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 375cade
🔍 Latest deploy log https://app.netlify.com/projects/knative/deploys/6af4f17463bf77fdbf17c1d6
😎 Deploy Preview https://deploy-preview-6773--knative.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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.
@aliok aliok changed the title WIP: Add Kafka functions pointer page Add Kafka functions pointer page Nov 11, 2026
@aliok
aliok marked this pull request as ready for review November 11, 2026 22:48
@knative-prow knative-prow Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 11, 2026
@knative-prow
knative-prow Bot requested a review from Cali0707 November 11, 2026 22:48
Signed-off-by: Ali Ok <aliok@redhat.com>

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

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.kafka reference.
  • Added the new page to the versioned Functions navigation.
  • The page should clarify that Kafka functions are supported by the raw and keda deployers, not the default knative deployer.
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.
@gauron99

Copy link
Copy Markdown
Contributor

/lgtm
/hold if any docs people want to look at this as well otherwise feel free to unhold

@knative-prow knative-prow Bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 11, 2026
@knative-prow knative-prow Bot added the lgtm Indicates that a PR is ready to be merged. label Nov 11, 2026
@aliok

aliok commented Nov 11, 2026

Copy link
Copy Markdown
Member Author

/unhold

@knative-prow knative-prow Bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 11, 2026
@knative-prow
knative-prow Bot merged commit 2846d05 into knative:main Nov 11, 2026
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants