fix(docs): update help docs for zarf connect to add clarity (#2662)

defenseunicorns · Jun 25, 2024 · 7cd2e16 · 7cd2e16
2 parents 2ecaaa0 + 043e7a2
commit 7cd2e16
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 10 deletions.
diff --git a/site/src/content/docs/commands/zarf_connect.md b/site/src/content/docs/commands/zarf_connect.md
@@ -29,11 +29,11 @@ zarf connect { REGISTRY | LOGGING | GIT | connect-name } [flags]
 ```
  --cli-only Disable browser auto-open
  -h, --help help for connect
- --local-port int (Optional, autogenerated if not provided) Specify the local port to bind to. E.g. local-port=42000
- --name string Specify the resource name. E.g. name=unicorns or name=unicorn-pod-7448499f4d-b5bk6
- --namespace string Specify the namespace. E.g. namespace=default (default "zarf")
- --remote-port int Specify the remote port of the resource to bind to. E.g. remote-port=8080
- --type string Specify the resource type. E.g. type=svc or type=pod (default "svc")
+ --local-port int (Optional, autogenerated if not provided) Specify the local port to bind to. E.g. local-port=42000. Ignored if --name is unset.
+ --name string Specify the resource name. E.g. name=unicorns or name=unicorn-pod-7448499f4d-b5bk6.
+ --namespace string Specify the namespace. E.g. namespace=default. Ignored if --name is unset. (default "zarf")
+ --remote-port int Specify the remote port of the resource to bind to. E.g. remote-port=8080. Ignored if --name is unset.
+ --type string Specify the resource type. E.g. type=svc or type=pod. Ignored if --name is unset. (default "svc")
 ```
 
 ### Options inherited from parent commands

diff --git a/src/config/lang/english.go b/src/config/lang/english.go
@@ -77,11 +77,11 @@ const (
  // zarf connect list
  CmdConnectListShort = "Lists all available connection shortcuts"
 
- CmdConnectFlagName = "Specify the resource name. E.g. name=unicorns or name=unicorn-pod-7448499f4d-b5bk6"
- CmdConnectFlagNamespace = "Specify the namespace. E.g. namespace=default"
- CmdConnectFlagType = "Specify the resource type. E.g. type=svc or type=pod"
- CmdConnectFlagLocalPort = "(Optional, autogenerated if not provided) Specify the local port to bind to. E.g. local-port=42000"
- CmdConnectFlagRemotePort = "Specify the remote port of the resource to bind to. E.g. remote-port=8080"
+ CmdConnectFlagName = "Specify the resource name. E.g. name=unicorns or name=unicorn-pod-7448499f4d-b5bk6."
+ CmdConnectFlagNamespace = "Specify the namespace. E.g. namespace=default. Ignored if --name is unset."
+ CmdConnectFlagType = "Specify the resource type. E.g. type=svc or type=pod. Ignored if --name is unset."
+ CmdConnectFlagLocalPort = "(Optional, autogenerated if not provided) Specify the local port to bind to. E.g. local-port=42000. Ignored if --name is unset."
+ CmdConnectFlagRemotePort = "Specify the remote port of the resource to bind to. E.g. remote-port=8080. Ignored if --name is unset."
  CmdConnectFlagCliOnly = "Disable browser auto-open"
 
  CmdConnectPreparingTunnel = "Preparing a tunnel to connect to %s"