Skip to content

Commit

Permalink
update help text to perform as expected
Browse files Browse the repository at this point in the history
Signed-off-by: Troy Connor <troy0820@users.noreply.github.com>
  • Loading branch information
troy0820 committed Jun 23, 2023
1 parent 14c8037 commit 09a86d7
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 12 deletions.
8 changes: 4 additions & 4 deletions cmd/porter/installations.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 {
Expand All @@ -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.
Expand Down
2 changes: 0 additions & 2 deletions docs/content/cli/explain.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
```
Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli/installations_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli/installations_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions docs/content/cli/installations_runs_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down
2 changes: 1 addition & 1 deletion docs/content/cli/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 09a86d7

Please sign in to comment.