generate-kpt-pkg-docs: Simple Example #

Overview #

This example shows how the generate-kpt-pkg-docs function works.

Running generate-kpt-pkg-docs function on the example package will:

  1. Update GENERATED.md file with the blueprint readme.

Fetch the example package #

Get the example package by running the following commands:

$ kpt pkg get https://github.com/kptdev/krm-functions-catalog.git/examples/generate-kpt-pkg-docs-simple

Function invocation #

Invoke the function with the following command:

$ kpt fn eval -i generate-kpt-pkg-docs:latest --include-meta-resources \
--mount type=bind,src="$(pwd)",dst="/tmp",rw=true -- readme-path=/tmp/GENERATED.md

Expected result #

  1. File GENERATED.md will be updated with the generated readme.