Add documentation about timeout format

Since we don't have a yaml example with duration and duration format is not very obvious, let's add a section in the documentation to document it. Signed-off-by: Chmouel Boudjnah <[email protected]>
tektoncd · Jan 10, 2020 · a50d3e7 · a50d3e7
1 parent 2d7d7ee
commit a50d3e7
Showing 1 changed file with 12 additions and 2 deletions.
diff --git a/docs/taskruns.md b/docs/taskruns.md
@@ -152,8 +152,18 @@ The `paths` field can be used to [override the paths to a resource](./resources.
 ### Configuring Default Timeout
 
 You can configure the default timeout by changing the value of `default-timeout-minutes`
-in [`config/config-defaults.yaml`](./../config/config-defaults.yaml). The default timeout
-is 60 minutes, if `default-timeout-minutes` is not available. There is no timeout by
+in [`config/config-defaults.yaml`](./../config/config-defaults.yaml).
+
+The `timeout` format is a `duration` as validated by Go's
+[`ParseDuration`](https://golang.org/pkg/time/#ParseDuration), valid format for
+examples are :
+
+- `1h30m`
+- `1h`
+- `1m`
+- `60s`
+
+The default timeout is 60 minutes, if `default-timeout-minutes` is not available. There is no timeout by
 default, if `default-timeout-minutes` is set to 0.
 
 ### Service Account