Update fn run docs. (#1361)

- Include example for printing a modification to stdout - Clarify that directory is an optional argument
kptdev · Jan 15, 2021 · 1391548 · 1391548
1 parent ed05661
commit 1391548
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/internal/docs/generated/fndocs/docs.go b/internal/docs/generated/fndocs/docs.go
diff --git a/site/content/en/reference/fn/run/_index.md b/site/content/en/reference/fn/run/_index.md
@@ -26,7 +26,7 @@ reference for advanced usecases.
 <!--mdtogo:Long-->
 
 ```sh
-kpt fn run DIR [flags]
+kpt fn run [DIR] [flags]
 ```
 
 If the container exits with non-zero status code, run will fail and print the
@@ -65,6 +65,12 @@ kpt fn run DIR/ --fn-path FUNCTIONS_DIR/
 kpt fn run DIR/
 ```
 
+```sh
+# pipe a resource from stdin and execute a function against it.
+# print the results to stdout
+kpt fn source . | kpt fn run --image gcr.io/example.com/my-fn
+```
+
 <!--mdtogo-->
 
 ## Structured Results