From 09a86d70cbe1e7d9c8b349f108c9dbe398433e0a Mon Sep 17 00:00:00 2001 From: Troy Connor Date: Fri, 23 Jun 2023 10:20:31 -0400 Subject: [PATCH] update help text to perform as expected Signed-off-by: Troy Connor --- cmd/porter/installations.go | 8 ++++---- docs/content/cli/explain.md | 2 -- docs/content/cli/install.md | 2 +- docs/content/cli/installations_install.md | 2 +- docs/content/cli/installations_list.md | 2 +- docs/content/cli/installations_runs_list.md | 4 ++-- docs/content/cli/list.md | 2 +- 7 files changed, 10 insertions(+), 12 deletions(-) diff --git a/cmd/porter/installations.go b/cmd/porter/installations.go index 8673d3cb7..37f684ba5 100644 --- a/cmd/porter/installations.go +++ b/cmd/porter/installations.go @@ -42,7 +42,7 @@ func buildInstallationsListCommand(p *porter.Porter) *cobra.Command { A listing of bundles currently installed by Porter will be provided, along with metadata such as creation time, last action, last status, etc. Optionally filters the results name, which returns all results whose name contain the provided query. -The results may also be filtered by associated labels and the namespace in which the installation is defined. +The results may also be filtered by associated labels and the namespace in which the installation is defined. Optional output formats include json and yaml.`, Example: ` porter installations list @@ -190,9 +190,9 @@ func buildInstallationRunsListCommand(p *porter.Porter) *cobra.Command { Use: "list", Short: "List runs of an Installation", Long: "List runs of an Installation", - Example: ` porter installation runs list [NAME] [--namespace NAMESPACE] [--output FORMAT] + Example: ` porter installations runs list [NAME] [--namespace NAMESPACE] [--output FORMAT] - porter installations runs list --name myapp --namespace dev + porter installations runs list myapp --namespace dev `, PreRunE: func(cmd *cobra.Command, args []string) error { @@ -219,7 +219,7 @@ func buildInstallationInstallCommand(p *porter.Porter) *cobra.Command { Short: "Create a new installation of a bundle", Long: `Create a new installation of a bundle. -The first argument is the name of the installation to create. This defaults to the name of the bundle. +The first argument is the name of the installation to create. This defaults to the name of the bundle. Once a bundle has been successfully installed, the install action cannot be repeated. This is a precaution to avoid accidentally overwriting an existing installation. If you need to re-run install, which is common when authoring a bundle, you can use the --force flag to by-pass this check. diff --git a/docs/content/cli/explain.md b/docs/content/cli/explain.md index 35eb41c65..56ce5646f 100644 --- a/docs/content/cli/explain.md +++ b/docs/content/cli/explain.md @@ -11,8 +11,6 @@ Explain a bundle Explain how to use a bundle by printing the parameters, credentials, outputs, actions. -The [Custom](../bundle/manifest/_index.md#custom) section data is only shown when the output format is JSON or YAML. Because the data can have an arbitrary structure, there is no coherent way to display it in a table. - ``` porter explain REFERENCE [flags] ``` diff --git a/docs/content/cli/install.md b/docs/content/cli/install.md index 4cef111f7..138ad373d 100644 --- a/docs/content/cli/install.md +++ b/docs/content/cli/install.md @@ -11,7 +11,7 @@ Create a new installation of a bundle Create a new installation of a bundle. -The first argument is the name of the installation to create. This defaults to the name of the bundle. +The first argument is the name of the installation to create. This defaults to the name of the bundle. Once a bundle has been successfully installed, the install action cannot be repeated. This is a precaution to avoid accidentally overwriting an existing installation. If you need to re-run install, which is common when authoring a bundle, you can use the --force flag to by-pass this check. diff --git a/docs/content/cli/installations_install.md b/docs/content/cli/installations_install.md index c36780838..bafd069ce 100644 --- a/docs/content/cli/installations_install.md +++ b/docs/content/cli/installations_install.md @@ -11,7 +11,7 @@ Create a new installation of a bundle Create a new installation of a bundle. -The first argument is the name of the installation to create. This defaults to the name of the bundle. +The first argument is the name of the installation to create. This defaults to the name of the bundle. Once a bundle has been successfully installed, the install action cannot be repeated. This is a precaution to avoid accidentally overwriting an existing installation. If you need to re-run install, which is common when authoring a bundle, you can use the --force flag to by-pass this check. diff --git a/docs/content/cli/installations_list.md b/docs/content/cli/installations_list.md index 168876f5f..e19fffadd 100644 --- a/docs/content/cli/installations_list.md +++ b/docs/content/cli/installations_list.md @@ -13,7 +13,7 @@ List all bundles installed by Porter. A listing of bundles currently installed by Porter will be provided, along with metadata such as creation time, last action, last status, etc. Optionally filters the results name, which returns all results whose name contain the provided query. -The results may also be filtered by associated labels and the namespace in which the installation is defined. +The results may also be filtered by associated labels and the namespace in which the installation is defined. Optional output formats include json and yaml. diff --git a/docs/content/cli/installations_runs_list.md b/docs/content/cli/installations_runs_list.md index 4cb98713a..c8f60a674 100644 --- a/docs/content/cli/installations_runs_list.md +++ b/docs/content/cli/installations_runs_list.md @@ -18,9 +18,9 @@ porter installations runs list [flags] ### Examples ``` - porter installation runs list [NAME] [--namespace NAMESPACE] [--output FORMAT] + porter installations runs list [NAME] [--namespace NAMESPACE] [--output FORMAT] - porter installations runs list --name myapp --namespace dev + porter installations runs list myapp --namespace dev ``` diff --git a/docs/content/cli/list.md b/docs/content/cli/list.md index 93517045a..774fa7439 100644 --- a/docs/content/cli/list.md +++ b/docs/content/cli/list.md @@ -13,7 +13,7 @@ List all bundles installed by Porter. A listing of bundles currently installed by Porter will be provided, along with metadata such as creation time, last action, last status, etc. Optionally filters the results name, which returns all results whose name contain the provided query. -The results may also be filtered by associated labels and the namespace in which the installation is defined. +The results may also be filtered by associated labels and the namespace in which the installation is defined. Optional output formats include json and yaml.