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

docs: move slugs to aliases #3021

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
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
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
7 changes: 4 additions & 3 deletions docs/content/docs/references/cli/archive.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
7 changes: 4 additions & 3 deletions docs/content/docs/references/cli/build.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
7 changes: 4 additions & 3 deletions docs/content/docs/references/cli/bundles/archive.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
7 changes: 4 additions & 3 deletions docs/content/docs/references/cli/bundles/build.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
13 changes: 7 additions & 6 deletions docs/content/docs/references/cli/bundles/copy.md
Original file line number Diff line number Diff line change
@@ -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.


Expand All @@ -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
Expand Down
7 changes: 4 additions & 3 deletions docs/content/docs/references/cli/bundles/create.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
9 changes: 5 additions & 4 deletions docs/content/docs/references/cli/bundles/explain.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down
10 changes: 5 additions & 5 deletions docs/content/docs/references/cli/bundles/inspect.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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]
```
Expand All @@ -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
Expand Down
7 changes: 4 additions & 3 deletions docs/content/docs/references/cli/bundles/lint.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
7 changes: 4 additions & 3 deletions docs/content/docs/references/cli/completion.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
12 changes: 6 additions & 6 deletions docs/content/docs/references/cli/copy.md
Original file line number Diff line number Diff line change
@@ -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]
```
Expand Down
7 changes: 4 additions & 3 deletions docs/content/docs/references/cli/create.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
7 changes: 4 additions & 3 deletions docs/content/docs/references/cli/credentials/apply.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
7 changes: 4 additions & 3 deletions docs/content/docs/references/cli/credentials/create.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
7 changes: 4 additions & 3 deletions docs/content/docs/references/cli/credentials/delete.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
7 changes: 4 additions & 3 deletions docs/content/docs/references/cli/credentials/edit.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
9 changes: 5 additions & 4 deletions docs/content/docs/references/cli/credentials/generate.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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]
Expand Down
7 changes: 4 additions & 3 deletions docs/content/docs/references/cli/credentials/list.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
7 changes: 4 additions & 3 deletions docs/content/docs/references/cli/credentials/show.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
7 changes: 4 additions & 3 deletions docs/content/docs/references/cli/explain.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 4 additions & 4 deletions docs/content/docs/references/cli/inspect.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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]
```
Expand Down
7 changes: 4 additions & 3 deletions docs/content/docs/references/cli/install.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
7 changes: 4 additions & 3 deletions docs/content/docs/references/cli/installations/apply.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
7 changes: 4 additions & 3 deletions docs/content/docs/references/cli/installations/delete.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Loading
Loading