Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update help text to perform as expected #2794

Merged
merged 3 commits into from
Jun 27, 2023
Merged

Update help text to perform as expected #2794

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
09a86d7
update help text to perform as expected
troy0820 Jun 23, 2023
196ddef
Merge branch 'main' into troy0820/update-help-test
schristoff Jun 23, 2023
c053fa9
Merge branch 'main' into troy0820/update-help-test
schristoff Jun 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions cmd/porter/installations.go
View file
Open in desktop
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: 1 addition & 1 deletion docs/content/cli/install.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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