Update the magefile DocsBuild target to new location of CLI reference (…

…#3129) PR #2897 moved the CLI reference file, but the CLI reference generation still points to the old location. Signed-off-by: Kim Christensen <[email protected]>
getporter · May 23, 2024 · 8e43c20 · 8e43c20
1 parent 16f5d6a
commit 8e43c20
Show file tree

Hide file tree

Showing 78 changed files with 593 additions and 571 deletions.
diff --git a/docs/content/docs/references/cli/_index.md b/docs/content/docs/references/cli/_index.md
diff --git a/docs/content/docs/references/cli/archive.md b/docs/content/docs/references/cli/archive.md
@@ -20,16 +20,18 @@ porter archive FILENAME --reference PUBLISHED_BUNDLE [flags]
 ```
   porter archive mybun.tgz --reference ghcr.io/getporter/examples/porter-hello:v0.2.0
   porter archive mybun.tgz --reference localhost:5000/ghcr.io/getporter/examples/porter-hello:v0.2.0 --force
+  porter archive mybun.tgz --compression NoCompression --reference ghcr.io/getporter/examples/porter-hello:v0.2.0
 
 ```
 
 ### Options
 
 ```
-      --force               Force a fresh pull of the bundle
-  -h, --help                help for archive
-      --insecure-registry   Don't require TLS for the registry
-  -r, --reference string    Use a bundle in an OCI registry specified by the given reference.
+  -c, --compression string   Compression level to use when creating the gzipped tar archive. Allowed values are: BestCompression, BestSpeed, DefaultCompression, HuffmanOnly, NoCompression (default "DefaultCompression")
+      --force                Force a fresh pull of the bundle
+  -h, --help                 help for archive
+      --insecure-registry    Don't require TLS for the registry
+  -r, --reference string     Use a bundle in an OCI registry specified by the given reference.
 ```
 
 ### Options inherited from parent commands

diff --git a/docs/content/docs/references/cli/bundles.md b/docs/content/docs/references/cli/bundles.md
@@ -0,0 +1,42 @@
+---
+title: "porter bundles"
+slug: porter_bundles
+url: /cli/porter_bundles/
+---
+## porter bundles
+
+Bundle commands
+
+### Synopsis
+
+Commands for working with bundles. These all have shortcuts so that you can call these commands without the bundle resource prefix. For example, porter bundle build is available as porter build as well.
+
+### Options
+
+```
+  -h, --help   help for bundles
+```
+
+### Options inherited from parent commands
+
+```
+      --experimental strings   Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
+      --verbosity string       Threshold for printing messages to the console. Available values are: debug, info, warning, error. (default "info")
+```
+
+### SEE ALSO
+
+* [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
+* [porter bundles create](/cli/porter_bundles_create/)	 - Create a bundle
+* [porter bundles explain](/cli/porter_bundles_explain/)	 - Explain a bundle
+* [porter bundles inspect](/cli/porter_bundles_inspect/)	 - Inspect a bundle
+* [porter bundles lint](/cli/porter_bundles_lint/)	 - Lint a bundle
+
diff --git a/docs/content/docs/references/cli/bundles/_index.md b/docs/content/docs/references/cli/bundles/_index.md
diff --git a/...nt/docs/references/cli/bundles/archive.md → ...nt/docs/references/cli/bundles_archive.md b/...nt/docs/references/cli/bundles/archive.md → ...nt/docs/references/cli/bundles_archive.md
@@ -20,16 +20,18 @@ porter bundles archive FILENAME --reference PUBLISHED_BUNDLE [flags]
 ```
   porter bundle archive mybun.tgz --reference ghcr.io/getporter/examples/porter-hello:v0.2.0
   porter bundle archive mybun.tgz --reference localhost:5000/ghcr.io/getporter/examples/porter-hello:v0.2.0 --force
+  porter bundle archive mybun.tgz --compression NoCompression --reference ghcr.io/getporter/examples/porter-hello:v0.2.0
 
 ```
 
 ### Options
 
 ```
-      --force               Force a fresh pull of the bundle
-  -h, --help                help for archive
-      --insecure-registry   Don't require TLS for the registry
-  -r, --reference string    Use a bundle in an OCI registry specified by the given reference.
+  -c, --compression string   Compression level to use when creating the gzipped tar archive. Allowed values are: BestCompression, BestSpeed, DefaultCompression, HuffmanOnly, NoCompression (default "DefaultCompression")
+      --force                Force a fresh pull of the bundle
+  -h, --help                 help for archive
+      --insecure-registry    Don't require TLS for the registry
+  -r, --reference string     Use a bundle in an OCI registry specified by the given reference.
 ```
 
 ### Options inherited from parent commands

diff --git a/...tent/docs/references/cli/bundles/build.md → ...tent/docs/references/cli/bundles_build.md b/...tent/docs/references/cli/bundles/build.md → ...tent/docs/references/cli/bundles_build.md
diff --git a/...ntent/docs/references/cli/bundles/copy.md → ...ntent/docs/references/cli/bundles_copy.md b/...ntent/docs/references/cli/bundles/copy.md → ...ntent/docs/references/cli/bundles_copy.md
diff --git a/...ent/docs/references/cli/bundles/create.md → ...ent/docs/references/cli/bundles_create.md b/...ent/docs/references/cli/bundles/create.md → ...ent/docs/references/cli/bundles_create.md
@@ -9,7 +9,7 @@ Create a bundle
 
 ### Synopsis
 
-Create a bundle. This generates a porter bundle in the directory with the specified name or in the current directory if no name is provided.
+Create a bundle. This command creates a new porter bundle with the specified bundle-name, in the directory with the specified bundle-name. The directory will be created if it doesn't already exist. If no bundle-name is provided, the bundle will be created in current directory and the bundle name will be 'porter-hello'.
 
 ```
 porter bundles create [bundle-name] [flags]

diff --git a/...nt/docs/references/cli/bundles/explain.md → ...nt/docs/references/cli/bundles_explain.md b/...nt/docs/references/cli/bundles/explain.md → ...nt/docs/references/cli/bundles_explain.md
diff --git a/...nt/docs/references/cli/bundles/inspect.md → ...nt/docs/references/cli/bundles_inspect.md b/...nt/docs/references/cli/bundles/inspect.md → ...nt/docs/references/cli/bundles_inspect.md
@@ -2,8 +2,6 @@
 title: "porter bundles inspect"
 slug: porter_bundles_inspect
 url: /cli/porter_bundles_inspect/
-aliases:
-  - /inspect-bundles
 ---
 ## porter bundles inspect
 

diff --git a/...ntent/docs/references/cli/bundles/lint.md → ...ntent/docs/references/cli/bundles_lint.md b/...ntent/docs/references/cli/bundles/lint.md → ...ntent/docs/references/cli/bundles_lint.md
diff --git a/docs/content/docs/references/cli/create.md b/docs/content/docs/references/cli/create.md
@@ -9,7 +9,7 @@ Create a bundle
 
 ### Synopsis
 
-Create a bundle. This generates a porter bundle in the directory with the specified name or in the current directory if no name is provided.
+Create a bundle. This command creates a new porter bundle with the specified bundle-name, in the directory with the specified bundle-name. The directory will be created if it doesn't already exist. If no bundle-name is provided, the bundle will be created in current directory and the bundle name will be 'porter-hello'.
 
 ```
 porter create [bundle-name] [flags]

diff --git a/docs/content/docs/references/cli/credentials.md b/docs/content/docs/references/cli/credentials.md
@@ -0,0 +1,38 @@
+---
+title: "porter credentials"
+slug: porter_credentials
+url: /cli/porter_credentials/
+---
+## porter credentials
+
+Credentials commands
+
+### Options
+
+```
+  -h, --help   help for credentials
+```
+
+### Options inherited from parent commands
+
+```
+      --experimental strings   Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
+      --verbosity string       Threshold for printing messages to the console. Available values are: debug, info, warning, error. (default "info")
+```
+
+### SEE ALSO
+
+* [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 create](/cli/porter_credentials_create/)	 - Create a Credential
+* [porter credentials delete](/cli/porter_credentials_delete/)	 - Delete a Credential
+* [porter credentials edit](/cli/porter_credentials_edit/)	 - Edit Credential
+* [porter credentials generate](/cli/porter_credentials_generate/)	 - Generate Credential Set
+* [porter credentials list](/cli/porter_credentials_list/)	 - List credentials
+* [porter credentials show](/cli/porter_credentials_show/)	 - Show a Credential
+
diff --git a/docs/content/docs/references/cli/credentials/_index.md b/docs/content/docs/references/cli/credentials/_index.md
diff --git a/.../docs/references/cli/credentials/apply.md → .../docs/references/cli/credentials_apply.md b/.../docs/references/cli/credentials/apply.md → .../docs/references/cli/credentials_apply.md
diff --git a/...docs/references/cli/credentials/create.md → ...docs/references/cli/credentials_create.md b/...docs/references/cli/credentials/create.md → ...docs/references/cli/credentials_create.md
diff --git a/...docs/references/cli/credentials/delete.md → ...docs/references/cli/credentials_delete.md b/...docs/references/cli/credentials/delete.md → ...docs/references/cli/credentials_delete.md
diff --git a/...t/docs/references/cli/credentials/edit.md → ...t/docs/references/cli/credentials_edit.md b/...t/docs/references/cli/credentials/edit.md → ...t/docs/references/cli/credentials_edit.md
diff --git a/...cs/references/cli/credentials/generate.md → ...cs/references/cli/credentials_generate.md b/...cs/references/cli/credentials/generate.md → ...cs/references/cli/credentials_generate.md
diff --git a/...t/docs/references/cli/credentials/list.md → ...t/docs/references/cli/credentials_list.md b/...t/docs/references/cli/credentials/list.md → ...t/docs/references/cli/credentials_list.md
diff --git a/...t/docs/references/cli/credentials/show.md → ...t/docs/references/cli/credentials_show.md b/...t/docs/references/cli/credentials/show.md → ...t/docs/references/cli/credentials_show.md
diff --git a/docs/content/docs/references/cli/install.md b/docs/content/docs/references/cli/install.md
@@ -45,22 +45,24 @@ porter install [INSTALLATION] [flags]
 ### Options
 
 ```
-      --allow-docker-host-access     Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
-      --autobuild-disabled           Do not automatically build the bundle from source when the last build is out-of-date.
-      --cnab-file string             Path to the CNAB bundle.json file.
-  -c, --credential-set stringArray   Credential sets to use when running the bundle. It should be a named set of credentials and may be specified multiple times.
-      --debug                        Run the bundle in debug mode.
-  -d, --driver string                Specify a driver to use. Allowed values: docker, debug (default "docker")
-  -f, --file porter.yaml             Path to the Porter manifest. Defaults to porter.yaml in the current directory.
-      --force                        Force a fresh pull of the bundle
-  -h, --help                         help for install
-      --insecure-registry            Don't require TLS for the registry
-  -l, --label strings                Associate the specified labels with the installation. May be specified multiple times.
-  -n, --namespace string             Create the installation in the specified namespace. Defaults to the global namespace.
-      --no-logs                      Do not persist the bundle execution logs
-      --param stringArray            Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
-  -p, --parameter-set stringArray    Parameter sets to use when running the bundle. It should be a named set of parameters and may be specified multiple times.
-  -r, --reference string             Use a bundle in an OCI registry specified by the given reference.
+      --allow-docker-host-access        Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
+      --autobuild-disabled              Do not automatically build the bundle from source when the last build is out-of-date.
+      --cnab-file string                Path to the CNAB bundle.json file.
+  -c, --credential-set stringArray      Credential sets to use when running the bundle. It should be a named set of credentials and may be specified multiple times.
+      --debug                           Run the bundle in debug mode.
+  -d, --driver string                   Specify a driver to use. Allowed values: docker, debug (default "docker")
+  -f, --file porter.yaml                Path to the Porter manifest. Defaults to porter.yaml in the current directory.
+      --force                           Force a fresh pull of the bundle
+  -h, --help                            help for install
+      --insecure-registry               Don't require TLS for the registry
+  -l, --label strings                   Associate the specified labels with the installation. May be specified multiple times.
+      --mount-host-volume stringArray   Mount a host volume into the bundle. Format is <host path>:<container path>[:<option>]. May be specified multiple times. Option can be ro (read-only), rw (read-write), default is ro.
+  -n, --namespace string                Create the installation in the specified namespace. Defaults to the global namespace.
+      --no-logs                         Do not persist the bundle execution logs
+      --param stringArray               Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
+  -p, --parameter-set stringArray       Parameter sets to use when running the bundle. It should be a named set of parameters and may be specified multiple times.
+  -r, --reference string                Use a bundle in an OCI registry specified by the given reference.
+      --verify-bundle                   Verify the bundle signature before executing
 ```
 
 ### Options inherited from parent commands

diff --git a/docs/content/docs/references/cli/installations.md b/docs/content/docs/references/cli/installations.md
@@ -0,0 +1,46 @@
+---
+title: "porter installations"
+slug: porter_installations
+url: /cli/porter_installations/
+---
+## porter installations
+
+Installation commands
+
+### Synopsis
+
+Commands for working with installations of a bundle
+
+### Options
+
+```
+  -h, --help   help for installations
+```
+
+### Options inherited from parent commands
+
+```
+      --experimental strings   Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
+      --verbosity string       Threshold for printing messages to the console. Available values are: debug, info, warning, error. (default "info")
+```
+
+### SEE ALSO
+
+* [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 apply](/cli/porter_installations_apply/)	 - Apply changes to an installation
+* [porter installations delete](/cli/porter_installations_delete/)	 - Delete an installation
+* [porter installations install](/cli/porter_installations_install/)	 - Create a new installation of a bundle
+* [porter installations invoke](/cli/porter_installations_invoke/)	 - Invoke a custom action on an installation
+* [porter installations list](/cli/porter_installations_list/)	 - List installed bundles
+* [porter installations logs](/cli/porter_installations_logs/)	 - Installation Logs commands
+* [porter installations output](/cli/porter_installations_output/)	 - Output commands
+* [porter installations runs](/cli/porter_installations_runs/)	 - Commands for working with runs of an Installation
+* [porter installations show](/cli/porter_installations_show/)	 - Show an installation of a bundle
+* [porter installations uninstall](/cli/porter_installations_uninstall/)	 - Uninstall an installation
+* [porter installations upgrade](/cli/porter_installations_upgrade/)	 - Upgrade an installation
+
diff --git a/docs/content/docs/references/cli/installations/_index.md b/docs/content/docs/references/cli/installations/_index.md