From 9b01ac0910596dc2009ae735373b99e565beb96e Mon Sep 17 00:00:00 2001 From: Brian DeGeeter Date: Mon, 18 Mar 2024 20:53:54 -0700 Subject: [PATCH] docs: move slugs to aliases Signed-off-by: Brian DeGeeter --- .../concepts-and-components/intro-parameters.md | 2 +- docs/content/docs/references/cli/archive.md | 7 ++++--- docs/content/docs/references/cli/build.md | 7 ++++--- .../content/docs/references/cli/bundles/archive.md | 7 ++++--- docs/content/docs/references/cli/bundles/build.md | 7 ++++--- docs/content/docs/references/cli/bundles/copy.md | 13 +++++++------ docs/content/docs/references/cli/bundles/create.md | 7 ++++--- .../content/docs/references/cli/bundles/explain.md | 9 +++++---- .../content/docs/references/cli/bundles/inspect.md | 10 +++++----- docs/content/docs/references/cli/bundles/lint.md | 7 ++++--- docs/content/docs/references/cli/completion.md | 7 ++++--- docs/content/docs/references/cli/copy.md | 12 ++++++------ docs/content/docs/references/cli/create.md | 7 ++++--- .../docs/references/cli/credentials/apply.md | 7 ++++--- .../docs/references/cli/credentials/create.md | 7 ++++--- .../docs/references/cli/credentials/delete.md | 7 ++++--- .../docs/references/cli/credentials/edit.md | 7 ++++--- .../docs/references/cli/credentials/generate.md | 9 +++++---- .../docs/references/cli/credentials/list.md | 7 ++++--- .../docs/references/cli/credentials/show.md | 7 ++++--- docs/content/docs/references/cli/explain.md | 7 ++++--- docs/content/docs/references/cli/inspect.md | 8 ++++---- docs/content/docs/references/cli/install.md | 7 ++++--- .../docs/references/cli/installations/apply.md | 7 ++++--- .../docs/references/cli/installations/delete.md | 7 ++++--- .../docs/references/cli/installations/install.md | 14 +++++++------- .../docs/references/cli/installations/invoke.md | 7 ++++--- .../docs/references/cli/installations/list.md | 7 ++++--- .../docs/references/cli/installations/logs.md | 7 ++++--- .../docs/references/cli/installations/logs_show.md | 7 ++++--- .../docs/references/cli/installations/output.md | 7 ++++--- .../references/cli/installations/output_list.md | 7 ++++--- .../references/cli/installations/output_show.md | 7 ++++--- .../docs/references/cli/installations/runs.md | 7 ++++--- .../docs/references/cli/installations/runs_list.md | 7 ++++--- .../docs/references/cli/installations/show.md | 7 ++++--- .../docs/references/cli/installations/uninstall.md | 7 ++++--- .../docs/references/cli/installations/upgrade.md | 7 ++++--- docs/content/docs/references/cli/invoke.md | 7 ++++--- docs/content/docs/references/cli/lint.md | 7 ++++--- docs/content/docs/references/cli/list.md | 7 ++++--- docs/content/docs/references/cli/logs.md | 7 ++++--- docs/content/docs/references/cli/mixins/create.md | 7 ++++--- docs/content/docs/references/cli/mixins/feed.md | 7 ++++--- .../docs/references/cli/mixins/feed_generate.md | 9 +++++---- .../docs/references/cli/mixins/feed_template.md | 7 ++++--- docs/content/docs/references/cli/mixins/install.md | 7 ++++--- docs/content/docs/references/cli/mixins/list.md | 7 ++++--- docs/content/docs/references/cli/mixins/search.md | 7 ++++--- .../docs/references/cli/mixins/uninstall.md | 7 ++++--- .../docs/references/cli/parameters/apply.md | 4 +++- .../docs/references/cli/parameters/create.md | 4 +++- .../docs/references/cli/parameters/delete.md | 7 ++++--- .../content/docs/references/cli/parameters/edit.md | 4 +++- .../docs/references/cli/parameters/generate.md | 9 +++++---- .../content/docs/references/cli/parameters/list.md | 7 ++++--- .../content/docs/references/cli/parameters/show.md | 7 ++++--- .../content/docs/references/cli/plugins/install.md | 8 ++++---- docs/content/docs/references/cli/plugins/list.md | 7 ++++--- docs/content/docs/references/cli/plugins/search.md | 7 ++++--- docs/content/docs/references/cli/plugins/show.md | 7 ++++--- .../docs/references/cli/plugins/uninstall.md | 7 ++++--- docs/content/docs/references/cli/publish.md | 7 ++++--- docs/content/docs/references/cli/schema.md | 7 ++++--- docs/content/docs/references/cli/show.md | 7 ++++--- docs/content/docs/references/cli/storage/_index.md | 7 ++++--- .../docs/references/cli/storage/fix-permissions.md | 7 ++++--- .../content/docs/references/cli/storage/migrate.md | 7 ++++--- docs/content/docs/references/cli/uninstall.md | 7 ++++--- docs/content/docs/references/cli/upgrade.md | 7 ++++--- docs/content/docs/references/cli/version.md | 7 ++++--- 71 files changed, 291 insertions(+), 223 deletions(-) diff --git a/docs/content/docs/introduction/concepts-and-components/intro-parameters.md b/docs/content/docs/introduction/concepts-and-components/intro-parameters.md index dd6a39793..37bd9087d 100644 --- a/docs/content/docs/introduction/concepts-and-components/intro-parameters.md +++ b/docs/content/docs/introduction/concepts-and-components/intro-parameters.md @@ -41,7 +41,7 @@ an external secret store. Parameter Sets are created using the combination of [porter parameters create](/docs/references/cli/parameters/create) and [porter parameters apply](/docs/references/cli/parameters/apply). Afterwards a parameter set can be [edited](/docs/references/cli/parameters/edit) if changes are required. -See [porter parameters help](/docs/references/cli/porter/parameters/) for all available commands. +See [porter parameters help](/docs/references/cli/parameters/) for all available commands. Now when you execute the bundle you can pass the name of the parameter set to the command using the `--parameter-set` or `-p` flag, e.g. diff --git a/docs/content/docs/references/cli/archive.md b/docs/content/docs/references/cli/archive.md index 3bb2e7dd3..b5bd9c789 100644 --- a/docs/content/docs/references/cli/archive.md +++ b/docs/content/docs/references/cli/archive.md @@ -1,8 +1,9 @@ --- -title: "porter archive" -slug: porter_archive -url: /cli/porter_archive/ +title: 'porter archive' +aliases: + - /cli/porter_archive/ --- + ## porter archive Archive a bundle from a reference diff --git a/docs/content/docs/references/cli/build.md b/docs/content/docs/references/cli/build.md index e03550a5d..033011775 100644 --- a/docs/content/docs/references/cli/build.md +++ b/docs/content/docs/references/cli/build.md @@ -1,8 +1,9 @@ --- -title: "porter build" -slug: porter_build -url: /cli/porter_build/ +title: 'porter build' +aliases: + - /cli/porter_build/ --- + ## porter build Build a bundle diff --git a/docs/content/docs/references/cli/bundles/archive.md b/docs/content/docs/references/cli/bundles/archive.md index b2e6ab0bf..776fe4c2e 100644 --- a/docs/content/docs/references/cli/bundles/archive.md +++ b/docs/content/docs/references/cli/bundles/archive.md @@ -1,8 +1,9 @@ --- -title: "porter bundles archive" -slug: porter_bundles_archive -url: /cli/porter_bundles_archive/ +title: 'porter bundles archive' +aliases: + - /cli/porter_bundles_archive/ --- + ## porter bundles archive Archive a bundle from a reference diff --git a/docs/content/docs/references/cli/bundles/build.md b/docs/content/docs/references/cli/bundles/build.md index 1e6346752..7b926fb3b 100644 --- a/docs/content/docs/references/cli/bundles/build.md +++ b/docs/content/docs/references/cli/bundles/build.md @@ -1,8 +1,9 @@ --- -title: "porter bundles build" -slug: porter_bundles_build -url: /cli/porter_bundles_build/ +title: 'porter bundles build' +aliases: + - /cli/porter_bundles_build/ --- + ## porter bundles build Build a bundle diff --git a/docs/content/docs/references/cli/bundles/copy.md b/docs/content/docs/references/cli/bundles/copy.md index 6daec163a..33b79a267 100644 --- a/docs/content/docs/references/cli/bundles/copy.md +++ b/docs/content/docs/references/cli/bundles/copy.md @@ -1,17 +1,18 @@ --- -title: "porter bundles copy" -slug: porter_bundles_copy -url: /cli/porter_bundles_copy/ +title: 'porter bundles copy' +aliases: + - /cli/porter_bundles_copy/ --- + ## porter bundles copy Copy a bundle ### Synopsis -Copy a published bundle from one registry to another. +Copy a published bundle from one registry to another. Source bundle can be either a tagged reference or a digest reference. -Destination can be either a registry, a registry/repository, or a fully tagged bundle reference. +Destination can be either a registry, a registry/repository, or a fully tagged bundle reference. If the source bundle is a digest reference, destination must be a tagged reference. @@ -25,7 +26,7 @@ porter bundles copy [flags] porter bundle copy porter bundle copy --source ghcr.io/getporter/examples/porter-hello:v0.2.0 --destination portersh porter bundle copy --source ghcr.io/getporter/examples/porter-hello:v0.2.0 --destination portersh --insecure-registry - + ``` ### Options diff --git a/docs/content/docs/references/cli/bundles/create.md b/docs/content/docs/references/cli/bundles/create.md index 3abfb8200..fbfca8ce4 100644 --- a/docs/content/docs/references/cli/bundles/create.md +++ b/docs/content/docs/references/cli/bundles/create.md @@ -1,8 +1,9 @@ --- -title: "porter bundles create" -slug: porter_bundles_create -url: /cli/porter_bundles_create/ +title: 'porter bundles create' +aliases: + - /cli/porter_bundles_create/ --- + ## porter bundles create Create a bundle diff --git a/docs/content/docs/references/cli/bundles/explain.md b/docs/content/docs/references/cli/bundles/explain.md index b1b39b178..bdedea4b5 100644 --- a/docs/content/docs/references/cli/bundles/explain.md +++ b/docs/content/docs/references/cli/bundles/explain.md @@ -1,8 +1,9 @@ --- -title: "porter bundles explain" -slug: porter_bundles_explain -url: /cli/porter_bundles_explain/ +title: 'porter bundles explain' +aliases: + - /cli/porter_bundles_explain/ --- + ## porter bundles explain Explain a bundle @@ -24,7 +25,7 @@ porter bundles explain REFERENCE [flags] porter bundle explain --file another/porter.yaml porter bundle explain --cnab-file some/bundle.json porter bundle explain --action install - + ``` ### Options diff --git a/docs/content/docs/references/cli/bundles/inspect.md b/docs/content/docs/references/cli/bundles/inspect.md index 5224ef0f6..9c36e0add 100644 --- a/docs/content/docs/references/cli/bundles/inspect.md +++ b/docs/content/docs/references/cli/bundles/inspect.md @@ -1,8 +1,9 @@ --- -title: "porter bundles inspect" -slug: porter_bundles_inspect -url: /cli/porter_bundles_inspect/ +title: 'porter bundles inspect' +aliases: + - /cli/porter_bundles_inspect/ --- + ## porter bundles inspect Inspect a bundle @@ -14,7 +15,6 @@ Inspect a bundle by printing the invocation images and any related images images If you would like more information about the bundle, the porter explain command will provide additional information, like parameters, credentials, outputs and custom actions available. - ``` porter bundles inspect REFERENCE [flags] ``` @@ -27,7 +27,7 @@ porter bundles inspect REFERENCE [flags] porter bundle inspect localhost:5000/ghcr.io/getporter/examples/porter-hello:v0.2.0 --insecure-registry --force porter bundle inspect --file another/porter.yaml porter bundle inspect --cnab-file some/bundle.json - + ``` ### Options diff --git a/docs/content/docs/references/cli/bundles/lint.md b/docs/content/docs/references/cli/bundles/lint.md index 639fd6174..c4a66422a 100644 --- a/docs/content/docs/references/cli/bundles/lint.md +++ b/docs/content/docs/references/cli/bundles/lint.md @@ -1,8 +1,9 @@ --- -title: "porter bundles lint" -slug: porter_bundles_lint -url: /cli/porter_bundles_lint/ +title: 'porter bundles lint' +aliases: + - /cli/porter_bundles_lint/ --- + ## porter bundles lint Lint a bundle diff --git a/docs/content/docs/references/cli/completion.md b/docs/content/docs/references/cli/completion.md index 26d09f736..acdeded06 100644 --- a/docs/content/docs/references/cli/completion.md +++ b/docs/content/docs/references/cli/completion.md @@ -1,8 +1,9 @@ --- -title: "porter completion" -slug: porter_completion -url: /cli/porter_completion/ +title: 'porter completion' +aliases: + - /cli/porter_completion/ --- + ## porter completion Generate completion script diff --git a/docs/content/docs/references/cli/copy.md b/docs/content/docs/references/cli/copy.md index a4fabee6b..feaee89ac 100644 --- a/docs/content/docs/references/cli/copy.md +++ b/docs/content/docs/references/cli/copy.md @@ -1,20 +1,20 @@ --- -title: "porter copy" -slug: porter_copy -url: /cli/porter_copy/ +title: 'porter copy' +aliases: + - /cli/porter_copy/ --- + ## porter copy Copy a bundle ### Synopsis -Copy a published bundle from one registry to another. +Copy a published bundle from one registry to another. Source bundle can be either a tagged reference or a digest reference. -Destination can be either a registry, a registry/repository, or a fully tagged bundle reference. +Destination can be either a registry, a registry/repository, or a fully tagged bundle reference. If the source bundle is a digest reference, destination must be a tagged reference. - ``` porter copy [flags] ``` diff --git a/docs/content/docs/references/cli/create.md b/docs/content/docs/references/cli/create.md index 2ac4414cd..2a1741844 100644 --- a/docs/content/docs/references/cli/create.md +++ b/docs/content/docs/references/cli/create.md @@ -1,8 +1,9 @@ --- -title: "porter create" -slug: porter_create -url: /cli/porter_create/ +title: 'porter create' +aliases: + - /cli/porter_create/ --- + ## porter create Create a bundle diff --git a/docs/content/docs/references/cli/credentials/apply.md b/docs/content/docs/references/cli/credentials/apply.md index cd74fc013..9b0ae23fb 100644 --- a/docs/content/docs/references/cli/credentials/apply.md +++ b/docs/content/docs/references/cli/credentials/apply.md @@ -1,8 +1,9 @@ --- -title: "porter credentials apply" -slug: porter_credentials_apply -url: /cli/porter_credentials_apply/ +title: 'porter credentials apply' +aliases: + - /cli/porter_credentials_apply/ --- + ## porter credentials apply Apply changes to a credential set diff --git a/docs/content/docs/references/cli/credentials/create.md b/docs/content/docs/references/cli/credentials/create.md index 76f4fb09c..05cf4ec4b 100644 --- a/docs/content/docs/references/cli/credentials/create.md +++ b/docs/content/docs/references/cli/credentials/create.md @@ -1,8 +1,9 @@ --- -title: "porter credentials create" -slug: porter_credentials_create -url: /cli/porter_credentials_create/ +title: 'porter credentials create' +aliases: + - /cli/porter_credentials_create/ --- + ## porter credentials create Create a Credential diff --git a/docs/content/docs/references/cli/credentials/delete.md b/docs/content/docs/references/cli/credentials/delete.md index dc4e258d1..f969b61b9 100644 --- a/docs/content/docs/references/cli/credentials/delete.md +++ b/docs/content/docs/references/cli/credentials/delete.md @@ -1,8 +1,9 @@ --- -title: "porter credentials delete" -slug: porter_credentials_delete -url: /cli/porter_credentials_delete/ +title: 'porter credentials delete' +aliases: + - /cli/porter_credentials_delete/ --- + ## porter credentials delete Delete a Credential diff --git a/docs/content/docs/references/cli/credentials/edit.md b/docs/content/docs/references/cli/credentials/edit.md index f24c06d80..98d26625c 100644 --- a/docs/content/docs/references/cli/credentials/edit.md +++ b/docs/content/docs/references/cli/credentials/edit.md @@ -1,8 +1,9 @@ --- -title: "porter credentials edit" -slug: porter_credentials_edit -url: /cli/porter_credentials_edit/ +title: 'porter credentials edit' +aliases: + - /cli/porter_credentials_edit/ --- + ## porter credentials edit Edit Credential diff --git a/docs/content/docs/references/cli/credentials/generate.md b/docs/content/docs/references/cli/credentials/generate.md index 19d44f550..61a16c148 100644 --- a/docs/content/docs/references/cli/credentials/generate.md +++ b/docs/content/docs/references/cli/credentials/generate.md @@ -1,8 +1,9 @@ --- -title: "porter credentials generate" -slug: porter_credentials_generate -url: /cli/porter_credentials_generate/ +title: 'porter credentials generate' +aliases: + - /cli/porter_credentials_generate/ --- + ## porter credentials generate Generate Credential Set @@ -25,7 +26,7 @@ file system. When you wish to install, upgrade or delete a bundle, Porter will use the credential set to determine where to read the necessary information from and -will then provide it to the bundle in the correct location. +will then provide it to the bundle in the correct location. ``` porter credentials generate [NAME] [flags] diff --git a/docs/content/docs/references/cli/credentials/list.md b/docs/content/docs/references/cli/credentials/list.md index 5f500a281..d4ee2cd06 100644 --- a/docs/content/docs/references/cli/credentials/list.md +++ b/docs/content/docs/references/cli/credentials/list.md @@ -1,8 +1,9 @@ --- -title: "porter credentials list" -slug: porter_credentials_list -url: /cli/porter_credentials_list/ +title: 'porter credentials list' +aliases: + - /cli/porter_credentials_list/ --- + ## porter credentials list List credentials diff --git a/docs/content/docs/references/cli/credentials/show.md b/docs/content/docs/references/cli/credentials/show.md index 4c7f03c38..8f971dc1c 100644 --- a/docs/content/docs/references/cli/credentials/show.md +++ b/docs/content/docs/references/cli/credentials/show.md @@ -1,8 +1,9 @@ --- -title: "porter credentials show" -slug: porter_credentials_show -url: /cli/porter_credentials_show/ +title: 'porter credentials show' +aliases: + - /cli/porter_credentials_show/ --- + ## porter credentials show Show a Credential diff --git a/docs/content/docs/references/cli/explain.md b/docs/content/docs/references/cli/explain.md index 56ce5646f..6c164fd35 100644 --- a/docs/content/docs/references/cli/explain.md +++ b/docs/content/docs/references/cli/explain.md @@ -1,8 +1,9 @@ --- -title: "porter explain" -slug: porter_explain -url: /cli/porter_explain/ +title: 'porter explain' +aliases: + - /cli/porter_explain/ --- + ## porter explain Explain a bundle diff --git a/docs/content/docs/references/cli/inspect.md b/docs/content/docs/references/cli/inspect.md index ca0e31e41..b72883ec0 100644 --- a/docs/content/docs/references/cli/inspect.md +++ b/docs/content/docs/references/cli/inspect.md @@ -1,8 +1,9 @@ --- -title: "porter inspect" -slug: porter_inspect -url: /cli/porter_inspect/ +title: 'porter inspect' +aliases: + - /cli/porter_inspect/ --- + ## porter inspect Inspect a bundle @@ -14,7 +15,6 @@ Inspect a bundle by printing the invocation images and any related images images If you would like more information about the bundle, the porter explain command will provide additional information, like parameters, credentials, outputs and custom actions available. - ``` porter inspect REFERENCE [flags] ``` diff --git a/docs/content/docs/references/cli/install.md b/docs/content/docs/references/cli/install.md index 138ad373d..c98bb2524 100644 --- a/docs/content/docs/references/cli/install.md +++ b/docs/content/docs/references/cli/install.md @@ -1,8 +1,9 @@ --- -title: "porter install" -slug: porter_install -url: /cli/porter_install/ +title: 'porter install' +aliases: + - /cli/porter_install/ --- + ## porter install Create a new installation of a bundle diff --git a/docs/content/docs/references/cli/installations/apply.md b/docs/content/docs/references/cli/installations/apply.md index 8ef9bea1c..a2f829118 100644 --- a/docs/content/docs/references/cli/installations/apply.md +++ b/docs/content/docs/references/cli/installations/apply.md @@ -1,8 +1,9 @@ --- -title: "porter installations apply" -slug: porter_installations_apply -url: /cli/porter_installations_apply/ +title: 'porter installations apply' +aliases: + - /cli/porter_installations_apply/ --- + ## porter installations apply Apply changes to an installation diff --git a/docs/content/docs/references/cli/installations/delete.md b/docs/content/docs/references/cli/installations/delete.md index f47858403..939e829e7 100644 --- a/docs/content/docs/references/cli/installations/delete.md +++ b/docs/content/docs/references/cli/installations/delete.md @@ -1,8 +1,9 @@ --- -title: "porter installations delete" -slug: porter_installations_delete -url: /cli/porter_installations_delete/ +title: 'porter installations delete' +aliases: + - /cli/porter_installations_delete/ --- + ## porter installations delete Delete an installation diff --git a/docs/content/docs/references/cli/installations/install.md b/docs/content/docs/references/cli/installations/install.md index bafd069ce..19429dcf7 100644 --- a/docs/content/docs/references/cli/installations/install.md +++ b/docs/content/docs/references/cli/installations/install.md @@ -1,8 +1,9 @@ --- -title: "porter installations install" -slug: porter_installations_install -url: /cli/porter_installations_install/ +title: 'porter installations install' +aliases: + - /cli/porter_installations_install/ --- + ## porter installations install Create a new installation of a bundle @@ -19,10 +20,9 @@ Porter uses the docker driver as the default runtime for executing a bundle's in For example, the 'debug' driver may be specified, which simply logs the info given to it and then exits. The docker driver runs the bundle container using the local Docker host. To use a remote Docker host, set the following environment variables: - DOCKER_HOST (required) - DOCKER_TLS_VERIFY (optional) - DOCKER_CERT_PATH (optional) - +DOCKER_HOST (required) +DOCKER_TLS_VERIFY (optional) +DOCKER_CERT_PATH (optional) ``` porter installations install [INSTALLATION] [flags] diff --git a/docs/content/docs/references/cli/installations/invoke.md b/docs/content/docs/references/cli/installations/invoke.md index 777377255..8b8b0b3b3 100644 --- a/docs/content/docs/references/cli/installations/invoke.md +++ b/docs/content/docs/references/cli/installations/invoke.md @@ -1,8 +1,9 @@ --- -title: "porter installations invoke" -slug: porter_installations_invoke -url: /cli/porter_installations_invoke/ +title: 'porter installations invoke' +aliases: + - /cli/porter_installations_invoke/ --- + ## porter installations invoke Invoke a custom action on an installation diff --git a/docs/content/docs/references/cli/installations/list.md b/docs/content/docs/references/cli/installations/list.md index e19fffadd..7f3d9d8a4 100644 --- a/docs/content/docs/references/cli/installations/list.md +++ b/docs/content/docs/references/cli/installations/list.md @@ -1,8 +1,9 @@ --- -title: "porter installations list" -slug: porter_installations_list -url: /cli/porter_installations_list/ +title: 'porter installations list' +aliases: + - /cli/porter_installations_list/ --- + ## porter installations list List installed bundles diff --git a/docs/content/docs/references/cli/installations/logs.md b/docs/content/docs/references/cli/installations/logs.md index f2fd6720d..1def9dd9d 100644 --- a/docs/content/docs/references/cli/installations/logs.md +++ b/docs/content/docs/references/cli/installations/logs.md @@ -1,8 +1,9 @@ --- -title: "porter installations logs" -slug: porter_installations_logs -url: /cli/porter_installations_logs/ +title: 'porter installations logs' +aliases: + - /cli/porter_installations_logs/ --- + ## porter installations logs Installation Logs commands diff --git a/docs/content/docs/references/cli/installations/logs_show.md b/docs/content/docs/references/cli/installations/logs_show.md index 8711d6f5f..68207ec9f 100644 --- a/docs/content/docs/references/cli/installations/logs_show.md +++ b/docs/content/docs/references/cli/installations/logs_show.md @@ -1,8 +1,9 @@ --- -title: "porter installations logs show" -slug: porter_installations_logs_show -url: /cli/porter_installations_logs_show/ +title: 'porter installations logs show' +aliases: + - /cli/porter_installations_logs_show/ --- + ## porter installations logs show Show the logs from an installation diff --git a/docs/content/docs/references/cli/installations/output.md b/docs/content/docs/references/cli/installations/output.md index 00de43c14..aeead749a 100644 --- a/docs/content/docs/references/cli/installations/output.md +++ b/docs/content/docs/references/cli/installations/output.md @@ -1,8 +1,9 @@ --- -title: "porter installations output" -slug: porter_installations_output -url: /cli/porter_installations_output/ +title: 'porter installations output' +aliases: + - /cli/porter_installations_output/ --- + ## porter installations output Output commands diff --git a/docs/content/docs/references/cli/installations/output_list.md b/docs/content/docs/references/cli/installations/output_list.md index 78f8a9870..218a54d4c 100644 --- a/docs/content/docs/references/cli/installations/output_list.md +++ b/docs/content/docs/references/cli/installations/output_list.md @@ -1,8 +1,9 @@ --- -title: "porter installations output list" -slug: porter_installations_output_list -url: /cli/porter_installations_output_list/ +title: 'porter installations output list' +aliases: + - /cli/porter_installations_output_list/ --- + ## porter installations output list List installation outputs diff --git a/docs/content/docs/references/cli/installations/output_show.md b/docs/content/docs/references/cli/installations/output_show.md index 430a4ef8f..01cffccb3 100644 --- a/docs/content/docs/references/cli/installations/output_show.md +++ b/docs/content/docs/references/cli/installations/output_show.md @@ -1,8 +1,9 @@ --- -title: "porter installations output show" -slug: porter_installations_output_show -url: /cli/porter_installations_output_show/ +title: 'porter installations output show' +aliases: + - /cli/porter_installations_output_show/ --- + ## porter installations output show Show the output of an installation diff --git a/docs/content/docs/references/cli/installations/runs.md b/docs/content/docs/references/cli/installations/runs.md index 3f132ef4a..584cd845b 100644 --- a/docs/content/docs/references/cli/installations/runs.md +++ b/docs/content/docs/references/cli/installations/runs.md @@ -1,8 +1,9 @@ --- -title: "porter installations runs" -slug: porter_installations_runs -url: /cli/porter_installations_runs/ +title: 'porter installations runs' +aliases: + - /cli/porter_installations_runs/ --- + ## porter installations runs Commands for working with runs of an Installation diff --git a/docs/content/docs/references/cli/installations/runs_list.md b/docs/content/docs/references/cli/installations/runs_list.md index c8f60a674..43fedc881 100644 --- a/docs/content/docs/references/cli/installations/runs_list.md +++ b/docs/content/docs/references/cli/installations/runs_list.md @@ -1,8 +1,9 @@ --- -title: "porter installations runs list" -slug: porter_installations_runs_list -url: /cli/porter_installations_runs_list/ +title: 'porter installations runs list' +aliases: + - /cli/porter_installations_runs_list/ --- + ## porter installations runs list List runs of an Installation diff --git a/docs/content/docs/references/cli/installations/show.md b/docs/content/docs/references/cli/installations/show.md index 5f857a3d6..e0d3c15f3 100644 --- a/docs/content/docs/references/cli/installations/show.md +++ b/docs/content/docs/references/cli/installations/show.md @@ -1,8 +1,9 @@ --- -title: "porter installations show" -slug: porter_installations_show -url: /cli/porter_installations_show/ +title: 'porter installations show' +aliases: + - /cli/porter_installations_show/ --- + ## porter installations show Show an installation of a bundle diff --git a/docs/content/docs/references/cli/installations/uninstall.md b/docs/content/docs/references/cli/installations/uninstall.md index 942ff84e2..6428bd3fa 100644 --- a/docs/content/docs/references/cli/installations/uninstall.md +++ b/docs/content/docs/references/cli/installations/uninstall.md @@ -1,8 +1,9 @@ --- -title: "porter installations uninstall" -slug: porter_installations_uninstall -url: /cli/porter_installations_uninstall/ +title: 'porter installations uninstall' +aliases: + - /cli/porter_installations_uninstall/ --- + ## porter installations uninstall Uninstall an installation diff --git a/docs/content/docs/references/cli/installations/upgrade.md b/docs/content/docs/references/cli/installations/upgrade.md index 991099ab5..5ece48934 100644 --- a/docs/content/docs/references/cli/installations/upgrade.md +++ b/docs/content/docs/references/cli/installations/upgrade.md @@ -1,8 +1,9 @@ --- -title: "porter installations upgrade" -slug: porter_installations_upgrade -url: /cli/porter_installations_upgrade/ +title: 'porter installations upgrade' +aliases: + - /cli/porter_installations_upgrade/ --- + ## porter installations upgrade Upgrade an installation diff --git a/docs/content/docs/references/cli/invoke.md b/docs/content/docs/references/cli/invoke.md index ad4b2bfed..29c2efe72 100644 --- a/docs/content/docs/references/cli/invoke.md +++ b/docs/content/docs/references/cli/invoke.md @@ -1,8 +1,9 @@ --- -title: "porter invoke" -slug: porter_invoke -url: /cli/porter_invoke/ +title: 'porter invoke' +aliases: + - /cli/porter_invoke/ --- + ## porter invoke Invoke a custom action on an installation diff --git a/docs/content/docs/references/cli/lint.md b/docs/content/docs/references/cli/lint.md index 3862aa43f..3de298967 100644 --- a/docs/content/docs/references/cli/lint.md +++ b/docs/content/docs/references/cli/lint.md @@ -1,8 +1,9 @@ --- -title: "porter lint" -slug: porter_lint -url: /cli/porter_lint/ +title: 'porter lint' +aliases: + - /cli/porter_lint/ --- + ## porter lint Lint a bundle diff --git a/docs/content/docs/references/cli/list.md b/docs/content/docs/references/cli/list.md index 774fa7439..f66f33197 100644 --- a/docs/content/docs/references/cli/list.md +++ b/docs/content/docs/references/cli/list.md @@ -1,8 +1,9 @@ --- -title: "porter list" -slug: porter_list -url: /cli/porter_list/ +title: 'porter list' +aliases: + - /cli/porter_list/ --- + ## porter list List installed bundles diff --git a/docs/content/docs/references/cli/logs.md b/docs/content/docs/references/cli/logs.md index 27189ffb4..15a0a915c 100644 --- a/docs/content/docs/references/cli/logs.md +++ b/docs/content/docs/references/cli/logs.md @@ -1,8 +1,9 @@ --- -title: "porter logs" -slug: porter_logs -url: /cli/porter_logs/ +title: 'porter logs' +aliases: + - /cli/porter_logs/ --- + ## porter logs Show the logs from an installation diff --git a/docs/content/docs/references/cli/mixins/create.md b/docs/content/docs/references/cli/mixins/create.md index 030db9d34..bd5617551 100644 --- a/docs/content/docs/references/cli/mixins/create.md +++ b/docs/content/docs/references/cli/mixins/create.md @@ -1,8 +1,9 @@ --- -title: "porter mixins create" -slug: porter_mixins_create -url: /cli/porter_mixins_create/ +title: 'porter mixins create' +aliases: + - /cli/porter_mixins_create/ --- + ## porter mixins create Create a new mixin project based on the getporter/skeletor repository diff --git a/docs/content/docs/references/cli/mixins/feed.md b/docs/content/docs/references/cli/mixins/feed.md index 9dc45dcf7..faab7356a 100644 --- a/docs/content/docs/references/cli/mixins/feed.md +++ b/docs/content/docs/references/cli/mixins/feed.md @@ -1,8 +1,9 @@ --- -title: "porter mixins feed" -slug: porter_mixins_feed -url: /cli/porter_mixins_feed/ +title: 'porter mixins feed' +aliases: + - /cli/porter_mixins_feed/ --- + ## porter mixins feed Feed commands diff --git a/docs/content/docs/references/cli/mixins/feed_generate.md b/docs/content/docs/references/cli/mixins/feed_generate.md index 7a9a6f7ca..8a186ad6d 100644 --- a/docs/content/docs/references/cli/mixins/feed_generate.md +++ b/docs/content/docs/references/cli/mixins/feed_generate.md @@ -1,15 +1,16 @@ --- -title: "porter mixins feed generate" -slug: porter_mixins_feed_generate -url: /cli/porter_mixins_feed_generate/ +title: 'porter mixins feed generate' +aliases: + - /cli/porter_mixins_feed_generate/ --- + ## porter mixins feed generate Generate an atom feed from the mixins in a directory ### Synopsis -Generate an atom feed from the mixins in a directory. +Generate an atom feed from the mixins in a directory. A template is required, providing values for text properties such as the author name, base URLs and other values that cannot be inferred from the mixin file names. You can make a default template by running 'porter mixins feed template'. diff --git a/docs/content/docs/references/cli/mixins/feed_template.md b/docs/content/docs/references/cli/mixins/feed_template.md index cca18ba9a..d02368925 100644 --- a/docs/content/docs/references/cli/mixins/feed_template.md +++ b/docs/content/docs/references/cli/mixins/feed_template.md @@ -1,8 +1,9 @@ --- -title: "porter mixins feed template" -slug: porter_mixins_feed_template -url: /cli/porter_mixins_feed_template/ +title: 'porter mixins feed template' +aliases: + - /cli/porter_mixins_feed_template/ --- + ## porter mixins feed template Create an atom feed template diff --git a/docs/content/docs/references/cli/mixins/install.md b/docs/content/docs/references/cli/mixins/install.md index 234e1709b..33ee29db4 100644 --- a/docs/content/docs/references/cli/mixins/install.md +++ b/docs/content/docs/references/cli/mixins/install.md @@ -1,8 +1,9 @@ --- -title: "porter mixins install" -slug: porter_mixins_install -url: /cli/porter_mixins_install/ +title: 'porter mixins install' +aliases: + - /cli/porter_mixins_install/ --- + ## porter mixins install Install a mixin diff --git a/docs/content/docs/references/cli/mixins/list.md b/docs/content/docs/references/cli/mixins/list.md index 33e1d9bde..4761b2817 100644 --- a/docs/content/docs/references/cli/mixins/list.md +++ b/docs/content/docs/references/cli/mixins/list.md @@ -1,8 +1,9 @@ --- -title: "porter mixins list" -slug: porter_mixins_list -url: /cli/porter_mixins_list/ +title: 'porter mixins list' +aliases: + - /cli/porter_mixins_list/ --- + ## porter mixins list List installed mixins diff --git a/docs/content/docs/references/cli/mixins/search.md b/docs/content/docs/references/cli/mixins/search.md index 4f7bc7edd..d91d80c39 100644 --- a/docs/content/docs/references/cli/mixins/search.md +++ b/docs/content/docs/references/cli/mixins/search.md @@ -1,8 +1,9 @@ --- -title: "porter mixins search" -slug: porter_mixins_search -url: /cli/porter_mixins_search/ +title: 'porter mixins search' +aliases: + - /cli/porter_mixins_search/ --- + ## porter mixins search Search available mixins diff --git a/docs/content/docs/references/cli/mixins/uninstall.md b/docs/content/docs/references/cli/mixins/uninstall.md index 90c9c1d4c..7dbe9602d 100644 --- a/docs/content/docs/references/cli/mixins/uninstall.md +++ b/docs/content/docs/references/cli/mixins/uninstall.md @@ -1,8 +1,9 @@ --- -title: "porter mixins uninstall" -slug: porter_mixins_uninstall -url: /cli/porter_mixins_uninstall/ +title: 'porter mixins uninstall' +aliases: + - /cli/porter_mixins_uninstall/ --- + ## porter mixins uninstall Uninstall a mixin diff --git a/docs/content/docs/references/cli/parameters/apply.md b/docs/content/docs/references/cli/parameters/apply.md index 042e043c5..91d04e85e 100644 --- a/docs/content/docs/references/cli/parameters/apply.md +++ b/docs/content/docs/references/cli/parameters/apply.md @@ -1,5 +1,7 @@ --- -title: "Porter Parameters Apply" +title: 'Porter Parameters Apply' +aliases: + - /cli/porter_parameters_apply/ --- Apply changes to a parameter set diff --git a/docs/content/docs/references/cli/parameters/create.md b/docs/content/docs/references/cli/parameters/create.md index ebaa13d61..66663ccf4 100644 --- a/docs/content/docs/references/cli/parameters/create.md +++ b/docs/content/docs/references/cli/parameters/create.md @@ -1,5 +1,7 @@ --- -title: "Porter Parameters Create" +title: 'Porter Parameters Create' +aliases: + - /cli/porter_parameters_create/ --- Create a Parameter Set diff --git a/docs/content/docs/references/cli/parameters/delete.md b/docs/content/docs/references/cli/parameters/delete.md index f4c053af4..1ca5ac67e 100644 --- a/docs/content/docs/references/cli/parameters/delete.md +++ b/docs/content/docs/references/cli/parameters/delete.md @@ -1,8 +1,9 @@ --- -title: "porter parameters delete" -slug: porter_parameters_delete -url: /cli/porter_parameters_delete/ +title: 'porter parameters delete' +aliases: + - /cli/porter_parameters_delete/ --- + ## porter parameters delete Delete a Parameter Set diff --git a/docs/content/docs/references/cli/parameters/edit.md b/docs/content/docs/references/cli/parameters/edit.md index 3c64354d9..ac3aa1bd5 100644 --- a/docs/content/docs/references/cli/parameters/edit.md +++ b/docs/content/docs/references/cli/parameters/edit.md @@ -1,5 +1,7 @@ --- -title: "Porter Parameters Edit" +title: 'Porter Parameters Edit' +aliases: + - /cli/porter_parameters_edit/ --- Edit Parameter Set diff --git a/docs/content/docs/references/cli/parameters/generate.md b/docs/content/docs/references/cli/parameters/generate.md index c0dcbe012..d27f8d95d 100644 --- a/docs/content/docs/references/cli/parameters/generate.md +++ b/docs/content/docs/references/cli/parameters/generate.md @@ -1,8 +1,9 @@ --- -title: "porter parameters generate" -slug: porter_parameters_generate -url: /cli/porter_parameters_generate/ +title: 'porter parameters generate' +aliases: + - /cli/porter_parameters_generate/ --- + ## porter parameters generate Generate Parameter Set @@ -25,7 +26,7 @@ file system. When you wish to install, upgrade or delete a bundle, Porter will use the parameter set to determine where to read the necessary information from and -will then provide it to the bundle in the correct location. +will then provide it to the bundle in the correct location. ``` porter parameters generate [NAME] [flags] diff --git a/docs/content/docs/references/cli/parameters/list.md b/docs/content/docs/references/cli/parameters/list.md index d16e76b13..c7440c2f7 100644 --- a/docs/content/docs/references/cli/parameters/list.md +++ b/docs/content/docs/references/cli/parameters/list.md @@ -1,8 +1,9 @@ --- -title: "porter parameters list" -slug: porter_parameters_list -url: /cli/porter_parameters_list/ +title: 'porter parameters list' +aliases: + - /cli/porter_parameters_list/ --- + ## porter parameters list List parameter sets diff --git a/docs/content/docs/references/cli/parameters/show.md b/docs/content/docs/references/cli/parameters/show.md index 3ce5f6c9b..6593753c0 100644 --- a/docs/content/docs/references/cli/parameters/show.md +++ b/docs/content/docs/references/cli/parameters/show.md @@ -1,8 +1,9 @@ --- -title: "porter parameters show" -slug: porter_parameters_show -url: /cli/porter_parameters_show/ +title: 'porter parameters show' +aliases: + - /cli/porter_parameters_show/ --- + ## porter parameters show Show a Parameter Set diff --git a/docs/content/docs/references/cli/plugins/install.md b/docs/content/docs/references/cli/plugins/install.md index c1abf11ae..a9f1d06b7 100644 --- a/docs/content/docs/references/cli/plugins/install.md +++ b/docs/content/docs/references/cli/plugins/install.md @@ -1,15 +1,15 @@ --- -title: "porter plugins install" -slug: porter_plugins_install -url: /cli/porter_plugins_install/ +title: 'porter plugins install' +aliases: + - /cli/porter_plugins_install/ --- + ## porter plugins install Install plugins ### Synopsis - Porter offers two ways to install plugins. Users can install plugins one at a time or multiple plugins through a plugins definition file. Below command will install one plugin: diff --git a/docs/content/docs/references/cli/plugins/list.md b/docs/content/docs/references/cli/plugins/list.md index 1f3869d21..df5a79439 100644 --- a/docs/content/docs/references/cli/plugins/list.md +++ b/docs/content/docs/references/cli/plugins/list.md @@ -1,8 +1,9 @@ --- -title: "porter plugins list" -slug: porter_plugins_list -url: /cli/porter_plugins_list/ +title: 'porter plugins list' +aliases: + - /cli/porter_plugins_list/ --- + ## porter plugins list List installed plugins diff --git a/docs/content/docs/references/cli/plugins/search.md b/docs/content/docs/references/cli/plugins/search.md index 12a8eb6aa..2506e4031 100644 --- a/docs/content/docs/references/cli/plugins/search.md +++ b/docs/content/docs/references/cli/plugins/search.md @@ -1,8 +1,9 @@ --- -title: "porter plugins search" -slug: porter_plugins_search -url: /cli/porter_plugins_search/ +title: 'porter plugins search' +aliases: + - /cli/porter_plugins_search/ --- + ## porter plugins search Search available plugins diff --git a/docs/content/docs/references/cli/plugins/show.md b/docs/content/docs/references/cli/plugins/show.md index 8a65f41aa..5e16c80d6 100644 --- a/docs/content/docs/references/cli/plugins/show.md +++ b/docs/content/docs/references/cli/plugins/show.md @@ -1,8 +1,9 @@ --- -title: "porter plugins show" -slug: porter_plugins_show -url: /cli/porter_plugins_show/ +title: 'porter plugins show' +aliases: + - /cli/porter_plugins_show/ --- + ## porter plugins show Show details about an installed plugin diff --git a/docs/content/docs/references/cli/plugins/uninstall.md b/docs/content/docs/references/cli/plugins/uninstall.md index 474970c8f..dd4777c82 100644 --- a/docs/content/docs/references/cli/plugins/uninstall.md +++ b/docs/content/docs/references/cli/plugins/uninstall.md @@ -1,8 +1,9 @@ --- -title: "porter plugins uninstall" -slug: porter_plugins_uninstall -url: /cli/porter_plugins_uninstall/ +title: 'porter plugins uninstall' +aliases: + - /cli/porter_plugins_uninstall/ --- + ## porter plugins uninstall Uninstall a plugin diff --git a/docs/content/docs/references/cli/publish.md b/docs/content/docs/references/cli/publish.md index 27e0fa8a2..4e915d8ac 100644 --- a/docs/content/docs/references/cli/publish.md +++ b/docs/content/docs/references/cli/publish.md @@ -1,8 +1,9 @@ --- -title: "porter publish" -slug: porter_publish -url: /cli/porter_publish/ +title: 'porter publish' +aliases: + - /cli/porter_publish/ --- + ## porter publish Publish a bundle diff --git a/docs/content/docs/references/cli/schema.md b/docs/content/docs/references/cli/schema.md index c0464d938..07444945c 100644 --- a/docs/content/docs/references/cli/schema.md +++ b/docs/content/docs/references/cli/schema.md @@ -1,8 +1,9 @@ --- -title: "porter schema" -slug: porter_schema -url: /cli/porter_schema/ +title: 'porter schema' +aliases: + - /cli/porter_schema/ --- + ## porter schema Print the JSON schema for the Porter manifest diff --git a/docs/content/docs/references/cli/show.md b/docs/content/docs/references/cli/show.md index c8e2df4b3..f90301b5f 100644 --- a/docs/content/docs/references/cli/show.md +++ b/docs/content/docs/references/cli/show.md @@ -1,8 +1,9 @@ --- -title: "porter show" -slug: porter_show -url: /cli/porter_show/ +title: 'porter show' +aliases: + - /cli/porter_show/ --- + ## porter show Show an installation of a bundle diff --git a/docs/content/docs/references/cli/storage/_index.md b/docs/content/docs/references/cli/storage/_index.md index 2e728cb14..c776e06b5 100644 --- a/docs/content/docs/references/cli/storage/_index.md +++ b/docs/content/docs/references/cli/storage/_index.md @@ -1,8 +1,9 @@ --- -title: "porter storage" -slug: porter_storage -url: /cli/porter_storage/ +title: 'porter storage' +aliases: + - /cli/porter_storage/ --- + ## porter storage Manage data stored by Porter diff --git a/docs/content/docs/references/cli/storage/fix-permissions.md b/docs/content/docs/references/cli/storage/fix-permissions.md index 80581fbd2..54dc1625d 100644 --- a/docs/content/docs/references/cli/storage/fix-permissions.md +++ b/docs/content/docs/references/cli/storage/fix-permissions.md @@ -1,8 +1,9 @@ --- -title: "porter storage fix-permissions" -slug: porter_storage_fix-permissions -url: /cli/porter_storage_fix-permissions/ +title: 'porter storage fix-permissions' +aliases: + - /cli/porter_storage_fix-permissions/ --- + ## porter storage fix-permissions Fix the permissions on your PORTER_HOME directory diff --git a/docs/content/docs/references/cli/storage/migrate.md b/docs/content/docs/references/cli/storage/migrate.md index b40449712..be1376fd1 100644 --- a/docs/content/docs/references/cli/storage/migrate.md +++ b/docs/content/docs/references/cli/storage/migrate.md @@ -1,8 +1,9 @@ --- -title: "porter storage migrate" -slug: porter_storage_migrate -url: /cli/porter_storage_migrate/ +title: 'porter storage migrate' +aliases: + - /cli/porter_storage_migrate/ --- + ## porter storage migrate Migrate data from v0.38 to v1 diff --git a/docs/content/docs/references/cli/uninstall.md b/docs/content/docs/references/cli/uninstall.md index a0bce6f5f..3dde4b244 100644 --- a/docs/content/docs/references/cli/uninstall.md +++ b/docs/content/docs/references/cli/uninstall.md @@ -1,8 +1,9 @@ --- -title: "porter uninstall" -slug: porter_uninstall -url: /cli/porter_uninstall/ +title: 'porter uninstall' +aliases: + - /cli/porter_uninstall/ --- + ## porter uninstall Uninstall an installation diff --git a/docs/content/docs/references/cli/upgrade.md b/docs/content/docs/references/cli/upgrade.md index bc3318a92..13c2208c9 100644 --- a/docs/content/docs/references/cli/upgrade.md +++ b/docs/content/docs/references/cli/upgrade.md @@ -1,8 +1,9 @@ --- -title: "porter upgrade" -slug: porter_upgrade -url: /cli/porter_upgrade/ +title: 'porter upgrade' +aliases: + - /cli/porter_upgrade/ --- + ## porter upgrade Upgrade an installation diff --git a/docs/content/docs/references/cli/version.md b/docs/content/docs/references/cli/version.md index 0a35224c3..3b4f00b63 100644 --- a/docs/content/docs/references/cli/version.md +++ b/docs/content/docs/references/cli/version.md @@ -1,8 +1,9 @@ --- -title: "porter version" -slug: porter_version -url: /cli/porter_version/ +title: 'porter version' +aliases: + - /cli/porter_version/ --- + ## porter version Print the application version