From 3d6ef471b7b4ad50b64db770cff71f3f1130842a Mon Sep 17 00:00:00 2001 From: Zbynek Roubalik Date: Tue, 20 Sep 2022 13:54:09 +0200 Subject: [PATCH] chore: sync docs with source code (#1261) Signed-off-by: Zbynek Roubalik Signed-off-by: Zbynek Roubalik --- docs/reference/func.md | 2 +- docs/reference/func_build.md | 2 +- docs/reference/func_deploy.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/reference/func.md b/docs/reference/func.md index d3f185d84..84a745ca9 100644 --- a/docs/reference/func.md +++ b/docs/reference/func.md @@ -4,7 +4,7 @@ Serverless functions ### Synopsis -Serverless functions v0.0.0-source-2022-09-12T14:54:32-06:00 +Serverless functions v0.0.0-source-2022-09-20T08:13:19+02:00 Create, build and deploy Knative functions diff --git a/docs/reference/func_build.md b/docs/reference/func_build.md index fd6fa7669..7b252a244 100644 --- a/docs/reference/func_build.md +++ b/docs/reference/func_build.md @@ -52,7 +52,7 @@ func build --builder=pack --builder-image cnbs/sample-builder:bionic -p, --path string Path to the project directory (Env: $FUNC_PATH) (default ".") --platform string Target platform to build (e.g. linux/amd64). -u, --push Attempt to push the function image after being successfully built - -r, --registry string Registry + namespace part of the image to build, ex 'quay.io/myuser'. The full image name is automatically determined based on the local directory name. If not provided the registry will be taken from func.yaml (Env: $FUNC_REGISTRY) + -r, --registry string Registry + namespace part of the image to build, ex 'quay.io/myuser'. The full image name is automatically determined (Env: $FUNC_REGISTRY) ``` ### Options inherited from parent commands diff --git a/docs/reference/func_deploy.md b/docs/reference/func_deploy.md index 6665b453e..5fd9c720b 100644 --- a/docs/reference/func_deploy.md +++ b/docs/reference/func_deploy.md @@ -12,7 +12,7 @@ SYNOPSIS func deploy [-R|--remote] [-r|--registry] [-i|--image] [-n|--namespace] [-e|env] [-g|--git-url] [-t|git-branch] [-d|--git-dir] [-b|--build] [--builder] [--builder-image] [-p|--push] - [-c|--confirm] [-v|--verbose] + [--platform] [-c|--confirm] [-v|--verbose] DESCRIPTION @@ -95,7 +95,7 @@ func deploy -p, --path string Path to the project directory (Env: $FUNC_PATH) (default ".") --platform string Target platform to build (e.g. linux/amd64). -u, --push Push the function image to registry before deploying (Env: $FUNC_PUSH) (default true) - -r, --registry string Registry + namespace part of the image to build, ex 'ghcr.io/myuser'. The full image name is automatically determined based on the local directory name. If not provided the registry will be taken from func.yaml (Env: $FUNC_REGISTRY) + -r, --registry string Registry + namespace part of the image to build, ex 'ghcr.io/myuser'. The full image name is automatically determined. (Env: $FUNC_REGISTRY) --remote Trigger a remote deployment. Default is to deploy and build from the local system: $FUNC_REMOTE) ```