From df748b04f3dabc8f25845175f0a76f8b5ac82d5f Mon Sep 17 00:00:00 2001 From: Michele Costa Date: Fri, 21 Jun 2024 10:58:16 +0100 Subject: [PATCH] Add documentation of templating helper functions --- docs/templating-functions.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 docs/templating-functions.md diff --git a/docs/templating-functions.md b/docs/templating-functions.md new file mode 100644 index 00000000..702244fc --- /dev/null +++ b/docs/templating-functions.md @@ -0,0 +1,6 @@ +# Templating functions + +On top of golangs normal templating we provide some functions to make writitng references easier. +The (sprig functions)[http://masterminds.github.io/sprig/] are included along with some other functions that can be found in the (subpackages pkg.go.dev page)[https://pkg.go.dev/github.com/openshift/kube-compare/pkg/funcmap#pkg-functions] + +If you want to custom functions you can define them as a templates and include them a paths under `templateFunctionFiles` at the root of your reference `metadata.yml` \ No newline at end of file