some-image-foo: Example Title #
Overview #
- Explain what this particular example demonstrates.
- Include a link to the function reference (help doc) on first mention of the function.
Fetch the example package #
- Show exact
kpt
commands to get the example package. - If function config present:
- Show the example function config.
- Explain what this function config does. Focus on explaining this particular example, not repeating the function reference.
Function invocation #
- Show exact
kpt
commands to run the function.
Expected result #
- Describe the expected outcome of running the instructions above. This needs to be specific enough
so that the user is confident the function works as expected (Don’t just provide the command to
cat
a file).
Function Reference #
- Provide a link to the function help doc for reference.