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.

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 description of porter #1722

Merged
merged 1 commit into from
Aug 20, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 7 additions & 2 deletions cmd/porter/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,13 @@ func buildRootCommandFrom(p *porter.Porter) *cobra.Command {
var printVersion bool

cmd := &cobra.Command{
Use: "porter",
Short: "I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool",
Use: "porter",
Short: `With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.
`,
Example: ` porter create
porter build
porter install
Expand Down
7 changes: 6 additions & 1 deletion docs/content/cli/archive.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,10 @@ porter archive FILENAME --reference PUBLISHED_BUNDLE [flags]

### SEE ALSO

* [porter](/cli/porter/) - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool
* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.


7 changes: 6 additions & 1 deletion docs/content/cli/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,5 +49,10 @@ porter build [flags]

### SEE ALSO

* [porter](/cli/porter/) - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool
* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.


7 changes: 6 additions & 1 deletion docs/content/cli/bundles.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,12 @@ Commands for working with bundles. These all have shortcuts so that you can call

### SEE ALSO

* [porter](/cli/porter/) - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool
* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.

* [porter bundles archive](/cli/porter_bundles_archive/) - Archive a bundle from a reference
* [porter bundles build](/cli/porter_bundles_build/) - Build a bundle
* [porter bundles copy](/cli/porter_bundles_copy/) - Copy a bundle
Expand Down
7 changes: 6 additions & 1 deletion docs/content/cli/copy.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,10 @@ porter copy [flags]

### SEE ALSO

* [porter](/cli/porter/) - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool
* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.


7 changes: 6 additions & 1 deletion docs/content/cli/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,10 @@ porter create [flags]

### SEE ALSO

* [porter](/cli/porter/) - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool
* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.


7 changes: 6 additions & 1 deletion docs/content/cli/credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,12 @@ Credentials commands

### SEE ALSO

* [porter](/cli/porter/) - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool
* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.

* [porter credentials apply](/cli/porter_credentials_apply/) - Apply changes to a credential set
* [porter credentials delete](/cli/porter_credentials_delete/) - Delete a Credential
* [porter credentials edit](/cli/porter_credentials_edit/) - Edit Credential
Expand Down
7 changes: 6 additions & 1 deletion docs/content/cli/explain.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,5 +50,10 @@ porter explain [flags]

### SEE ALSO

* [porter](/cli/porter/) - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool
* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.


7 changes: 6 additions & 1 deletion docs/content/cli/inspect.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,5 +52,10 @@ porter inspect [flags]

### SEE ALSO

* [porter](/cli/porter/) - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool
* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.


7 changes: 6 additions & 1 deletion docs/content/cli/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,5 +62,10 @@ porter install [INSTALLATION] [flags]

### SEE ALSO

* [porter](/cli/porter/) - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool
* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.


7 changes: 6 additions & 1 deletion docs/content/cli/installations.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,12 @@ Commands for working with installations of a bundle

### SEE ALSO

* [porter](/cli/porter/) - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool
* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.

* [porter installations delete](/cli/porter_installations_delete/) - Delete an installation
* [porter installations list](/cli/porter_installations_list/) - List installed bundles
* [porter installations logs](/cli/porter_installations_logs/) - Installation Logs commands
Expand Down
7 changes: 6 additions & 1 deletion docs/content/cli/invoke.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,5 +61,10 @@ porter invoke [INSTALLATION] --action ACTION [flags]

### SEE ALSO

* [porter](/cli/porter/) - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool
* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.


7 changes: 6 additions & 1 deletion docs/content/cli/lint.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,10 @@ porter lint [flags]

### SEE ALSO

* [porter](/cli/porter/) - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool
* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.


7 changes: 6 additions & 1 deletion docs/content/cli/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,5 +52,10 @@ porter list [flags]

### SEE ALSO

* [porter](/cli/porter/) - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool
* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.


7 changes: 6 additions & 1 deletion docs/content/cli/logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,10 @@ porter logs [flags]

### SEE ALSO

* [porter](/cli/porter/) - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool
* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.


7 changes: 6 additions & 1 deletion docs/content/cli/mixins.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,12 @@ Mixin commands. Mixins assist with authoring bundles.

### SEE ALSO

* [porter](/cli/porter/) - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool
* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.

* [porter mixins feed](/cli/porter_mixins_feed/) - Feed commands
* [porter mixins install](/cli/porter_mixins_install/) - Install a mixin
* [porter mixins list](/cli/porter_mixins_list/) - List installed mixins
Expand Down
7 changes: 6 additions & 1 deletion docs/content/cli/parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,12 @@ Parameter set commands

### SEE ALSO

* [porter](/cli/porter/) - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool
* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.

* [porter parameters apply](/cli/porter_parameters_apply/) - Apply changes to a parameter set
* [porter parameters delete](/cli/porter_parameters_delete/) - Delete a Parameter Set
* [porter parameters edit](/cli/porter_parameters_edit/) - Edit Parameter Set
Expand Down
7 changes: 6 additions & 1 deletion docs/content/cli/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,12 @@ Plugin commands. Plugins enable Porter to work on different cloud providers and

### SEE ALSO

* [porter](/cli/porter/) - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool
* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.

* [porter plugins install](/cli/porter_plugins_install/) - Install a plugin
* [porter plugins list](/cli/porter_plugins_list/) - List installed plugins
* [porter plugins search](/cli/porter_plugins_search/) - Search available plugins
Expand Down
7 changes: 6 additions & 1 deletion docs/content/cli/porter.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,12 @@ url: /cli/porter/
---
## porter

I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool
With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.


```
porter [flags]
Expand Down
7 changes: 6 additions & 1 deletion docs/content/cli/publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,5 +52,10 @@ porter publish [flags]

### SEE ALSO

* [porter](/cli/porter/) - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool
* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.


7 changes: 6 additions & 1 deletion docs/content/cli/schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,10 @@ porter schema [flags]

### SEE ALSO

* [porter](/cli/porter/) - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool
* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.


7 changes: 6 additions & 1 deletion docs/content/cli/show.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,10 @@ Optional output formats include json and yaml.

### SEE ALSO

* [porter](/cli/porter/) - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool
* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.


7 changes: 6 additions & 1 deletion docs/content/cli/storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@ Manage the data stored by Porter, such as credentials and installation data.

### SEE ALSO

* [porter](/cli/porter/) - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool
* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.

* [porter storage migrate](/cli/porter_storage_migrate/) - Migrate active storage account

7 changes: 6 additions & 1 deletion docs/content/cli/uninstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,5 +64,10 @@ porter uninstall [INSTALLATION] [flags]

### SEE ALSO

* [porter](/cli/porter/) - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool
* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.


7 changes: 6 additions & 1 deletion docs/content/cli/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,5 +60,10 @@ porter upgrade [INSTALLATION] [flags]

### SEE ALSO

* [porter](/cli/porter/) - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool
* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.


7 changes: 6 additions & 1 deletion docs/content/cli/version.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,10 @@ porter version [flags]

### SEE ALSO

* [porter](/cli/porter/) - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool
* [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.