Skip to content

docs: add KRM function developer guide - #4726

Open
efiacor wants to merge 1 commit into
kptdev:mainfrom
Nordix:docs/krm-function-developer-guide
Open

docs: add KRM function developer guide#4726
efiacor wants to merge 1 commit into
kptdev:mainfrom
Nordix:docs/krm-function-developer-guide

Conversation

@efiacor

@efiacor efiacor commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a developer guide for writing KRM functions with the Go SDK, as a new subsection under guides/krm-functions/:

  • Tutorial — build a function end to end (embedded docs, golden tests, --help/--doc/standalone file mode)
  • Interfaces — when to use fn.Runner vs fn.ResourceListProcessor
  • Testing — golden test patterns and unit testing
  • Containerizing — packaging a function as a container image

The content is sourced from the krm-functions-sdk repo docs and adapted into Hugo pages (front matter, relref cross-links, absolute source links). The parent guides/_index.md links to the new subsection.

Testing

  • hugo content rendering succeeds with no relref resolution errors (local CSS post-processing step is blocked by a sandbox fs restriction unrelated to these changes; it builds in CI).

Refs #4725


This PR was prepared with AI assistance.

Add a developer guide for writing KRM functions with the Go SDK, covering
a tutorial, interface selection (fn.Runner vs fn.ResourceListProcessor),
testing, and containerizing. Sourced from the krm-functions-sdk docs and
adapted into a Hugo subsection under guides/.

Refs kptdev#4725

Signed-off-by: Fiachra Corcoran <fiachra.corcoran@est.tech>
@efiacor
efiacor requested review from a team September 2, 2026 01:02
@efiacor efiacor added the documentation Improvements or additions to documentation label Sep 2, 2026
@efiacor efiacor self-assigned this Sep 2, 2026
@netlify

netlify Bot commented Sep 2, 2026

Copy link
Copy Markdown

Deploy Preview for kptdocs ready!

Name Link
🔨 Latest commit ca9cd64
🔍 Latest deploy log https://app.netlify.com/projects/kptdocs/deploys/6a9775bb445cd2000848c70d
😎 Deploy Preview https://deploy-preview-4726--kptdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant