Note: Please ensure you follow the kpt doc style guide.
Explain what this function does in one or two sentences.
Describe why the user should care about this function.
What problem does it solve?
Provide some context (e.g. In the gatekeeper function, explain what's
is Gatekeeper project)
How do I use this function?
Explain what does it do in details.
Is this function meant to be used declaratively, imperatively or both?
Omit this section, if the function doesn't support any functionConfigs.
Otherwise, explain the function config and behavior for this function in detail.
For each field in the function config, specify:
- An example value
- Whether it is optional, and if so, the default value
If showing the function orchestrator (e.g. kpt) can make it clear about how to use the function, it's recommended to use it.
Omit this section if you are providing complete example kpt packages which are linked from the catalog site.
Otherwise, provide inline examples in this section.