From 7080d310ad3b21a9a7f7560132f008fd5ff5b2cf Mon Sep 17 00:00:00 2001 From: Faeka Ansari Date: Mon, 30 Sep 2024 14:06:34 +0530 Subject: [PATCH 1/4] freight alias command changed Signed-off-by: Faeka Ansari --- .../15-working-with-freight.md | 22 ++++++++++++++----- 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/docs/docs/30-how-to-guides/15-working-with-freight.md b/docs/docs/30-how-to-guides/15-working-with-freight.md index cf65ee896..fff5f5d43 100644 --- a/docs/docs/30-how-to-guides/15-working-with-freight.md +++ b/docs/docs/30-how-to-guides/15-working-with-freight.md @@ -112,12 +112,22 @@ resource as it progresses through the `Stage`s of a pipeline. This is conveniently accomplished via the Kargo CLI: -```shell -kargo update freight \ - f5f87aa23c9e97f43eb83dd63768ee41f5ba3766 \ - --alias frozen-tauntaun \ - --project kargo-demo -``` +1. **Using Name** + ```shell + kargo update freight \ + --project=kargo-demo \ + --name=f5f87aa23c9e97f43eb83dd63768ee41f5ba3766 \ + --new-alias=frozen-tauntaun + ``` + +1. **Using Old Alias**: + If you have the old alias and prefer to use it + ```shell + kargo update freight \ + --project=kargo-demo \ + --old-alias=mortal-dragonfly \ + --new-alias=frozen-tauntaun + ``` This can also be accomplished via `kubectl` commands `apply`, `edit`, `patch`, etc. by updating the `alias` field of the `Freight` resource. From fbc1fcc70b0c14bba7116e7e1810294eb58993ea Mon Sep 17 00:00:00 2001 From: Faeka Ansari Date: Mon, 30 Sep 2024 15:17:27 +0530 Subject: [PATCH 2/4] trivial: link working with freights in key concepts Signed-off-by: Faeka Ansari --- docs/docs/15-concepts.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/docs/15-concepts.md b/docs/docs/15-concepts.md index 4fd198435..cd55dea21 100644 --- a/docs/docs/15-concepts.md +++ b/docs/docs/15-concepts.md @@ -45,6 +45,8 @@ include one or more: Freight can therefore be thought of as a sort of meta-artifact. Freight is what Kargo seeks to progress from one stage to another. +For detailed guidance on how to effectively work with Freight, you can +refer to the [How-to Guide: Working with Freight](https://kargo.akuity.io/how-to-guides/working-with-freight). ### What is a Warehouse? From d1edb507fc00d5bdf8e54e2f1a2f5279e43e50b0 Mon Sep 17 00:00:00 2001 From: Faeka Ansari Date: Tue, 15 Oct 2024 09:52:08 +0530 Subject: [PATCH 3/4] address reviews Signed-off-by: Faeka Ansari --- docs/docs/15-concepts.md | 4 +-- .../15-working-with-freight.md | 29 +++++++++---------- 2 files changed, 15 insertions(+), 18 deletions(-) diff --git a/docs/docs/15-concepts.md b/docs/docs/15-concepts.md index cd55dea21..5e214c7bf 100644 --- a/docs/docs/15-concepts.md +++ b/docs/docs/15-concepts.md @@ -45,8 +45,8 @@ include one or more: Freight can therefore be thought of as a sort of meta-artifact. Freight is what Kargo seeks to progress from one stage to another. -For detailed guidance on how to effectively work with Freight, you can -refer to the [How-to Guide: Working with Freight](https://kargo.akuity.io/how-to-guides/working-with-freight). +For detailed guidance on working with Freight, refer to +[this guide](https://kargo.akuity.io/how-to-guides/working-with-freight). ### What is a Warehouse? diff --git a/docs/docs/30-how-to-guides/15-working-with-freight.md b/docs/docs/30-how-to-guides/15-working-with-freight.md index fff5f5d43..52e5204a3 100644 --- a/docs/docs/30-how-to-guides/15-working-with-freight.md +++ b/docs/docs/30-how-to-guides/15-working-with-freight.md @@ -112,22 +112,19 @@ resource as it progresses through the `Stage`s of a pipeline. This is conveniently accomplished via the Kargo CLI: -1. **Using Name** - ```shell - kargo update freight \ - --project=kargo-demo \ - --name=f5f87aa23c9e97f43eb83dd63768ee41f5ba3766 \ - --new-alias=frozen-tauntaun - ``` - -1. **Using Old Alias**: - If you have the old alias and prefer to use it - ```shell - kargo update freight \ - --project=kargo-demo \ - --old-alias=mortal-dragonfly \ - --new-alias=frozen-tauntaun - ``` +```shell +kargo update freight \ + --project=kargo-demo \ + --name=f5f87aa23c9e97f43eb83dd63768ee41f5ba3766 \ + --new-alias=frozen-tauntaun +``` +Alternatively, you can reference the `Freight` to which you want to assign a new alias using its existing alias: +```shell +kargo update freight \ + --project=kargo-demo \ + --old-alias=mortal-dragonfly \ + --new-alias=frozen-tauntaun +``` This can also be accomplished via `kubectl` commands `apply`, `edit`, `patch`, etc. by updating the `alias` field of the `Freight` resource. From 1249b8bb48a58a74345214bdf83c5a11136f3052 Mon Sep 17 00:00:00 2001 From: Faeka Ansari Date: Tue, 29 Oct 2024 20:16:44 +0530 Subject: [PATCH 4/4] fix space && link Signed-off-by: Faeka Ansari --- docs/docs/15-concepts.md | 2 +- docs/docs/30-how-to-guides/15-working-with-freight.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/docs/15-concepts.md b/docs/docs/15-concepts.md index 5e214c7bf..6479f1036 100644 --- a/docs/docs/15-concepts.md +++ b/docs/docs/15-concepts.md @@ -46,7 +46,7 @@ include one or more: Freight can therefore be thought of as a sort of meta-artifact. Freight is what Kargo seeks to progress from one stage to another. For detailed guidance on working with Freight, refer to -[this guide](https://kargo.akuity.io/how-to-guides/working-with-freight). +[this guide](./30-how-to-guides/15-working-with-freight.md). ### What is a Warehouse? diff --git a/docs/docs/30-how-to-guides/15-working-with-freight.md b/docs/docs/30-how-to-guides/15-working-with-freight.md index 52e5204a3..ca5bf822b 100644 --- a/docs/docs/30-how-to-guides/15-working-with-freight.md +++ b/docs/docs/30-how-to-guides/15-working-with-freight.md @@ -119,6 +119,7 @@ kargo update freight \ --new-alias=frozen-tauntaun ``` Alternatively, you can reference the `Freight` to which you want to assign a new alias using its existing alias: + ```shell kargo update freight \ --project=kargo-demo \