From b881e291d8ad5a95de8a038fc27b34f85fe9cd6e Mon Sep 17 00:00:00 2001 From: Hidde Beydals Date: Tue, 14 Jan 2025 17:32:14 +0100 Subject: [PATCH] docs: various small fixes (#3273) Signed-off-by: Hidde Beydals --- docs/docs/20-quickstart.md | 10 +++++----- docs/docs/30-how-to-guides/20-managing-credentials.md | 2 +- docs/docs/30-how-to-guides/25-argo-cd-integration.md | 2 +- docs/docs/35-references/10-promotion-steps.md | 4 ++-- docs/docs/40-contributor-guide/10-hacking-on-kargo.md | 6 +++--- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/docs/20-quickstart.md b/docs/docs/20-quickstart.md index b14740eb0..4bcc7c4e3 100644 --- a/docs/docs/20-quickstart.md +++ b/docs/docs/20-quickstart.md @@ -54,7 +54,7 @@ curl -L https://raw.githubusercontent.com/akuity/kargo/main/hack/quickstart/inst [OrbStack](https://orbstack.dev/) is a fast, lightweight, drop-in replacement -for Docker Desktop for Mac OS only. You can follow +for Docker Desktop for macOS only. You can follow [these instructions](https://docs.orbstack.dev/kubernetes/) to enable its built-in Kubernetes support. @@ -873,8 +873,8 @@ the previous section. :::note Although this example does not demonstrate it, it is also possible to verify the `Freight` in a `Stage` using user-defined processes. See the - [relevant section](./15-concepts.md#verifications) of the concepts page to - learn more. + [relevant section](./30-how-to-guides/14-working-with-stages.md#verifications) + to learn more. ::: ## Behind the Scenes @@ -929,7 +929,7 @@ Now let's clean up! Docker Desktop supports only a _single_ Kubernetes cluster. If you are -comfortable deleting not just just Kargo-related resources, but _all_ your +comfortable deleting not just Kargo-related resources, but _all_ your workloads and data, the cluster can be reset from the Docker Desktop Dashboard. @@ -944,7 +944,7 @@ curl -L https://raw.githubusercontent.com/akuity/kargo/main/hack/quickstart/unin OrbStack supports only a _single_ Kubernetes cluster. If you are -comfortable deleting not just just Kargo-related resources, but _all_ your +comfortable deleting not just Kargo-related resources, but _all_ your workloads and data, you can destroy the cluster with: ```shell diff --git a/docs/docs/30-how-to-guides/20-managing-credentials.md b/docs/docs/30-how-to-guides/20-managing-credentials.md index 65601e9de..37b864917 100644 --- a/docs/docs/30-how-to-guides/20-managing-credentials.md +++ b/docs/docs/30-how-to-guides/20-managing-credentials.md @@ -236,7 +236,7 @@ repository URL: ```shell kargo update credentials --project kargo-demo my-credentials \ - --repo-url '^http://github.com/' --regex + --repo-url '^https://github.com/' --regex ``` ```shell diff --git a/docs/docs/30-how-to-guides/25-argo-cd-integration.md b/docs/docs/30-how-to-guides/25-argo-cd-integration.md index 20604f207..a360b8ef1 100644 --- a/docs/docs/30-how-to-guides/25-argo-cd-integration.md +++ b/docs/docs/30-how-to-guides/25-argo-cd-integration.md @@ -14,7 +14,7 @@ and indirect integration with Argo CD, this page details certain key elements of the interactions between the two systems. :::note -This page is a work in progress. Thank you for your patience as as we work to add more details. +This page is a work in progress. Thank you for your patience as we work to add more details. ::: ## Updating Argo CD Applications diff --git a/docs/docs/35-references/10-promotion-steps.md b/docs/docs/35-references/10-promotion-steps.md index 848f8ad63..de67090e9 100644 --- a/docs/docs/35-references/10-promotion-steps.md +++ b/docs/docs/35-references/10-promotion-steps.md @@ -275,7 +275,7 @@ steps: ### `git-clear` -`git-clear` deletes the _the entire contents_ of a specified Git working tree +`git-clear` deletes _the entire contents_ of a specified Git working tree (except for the `.git` file). It is equivalent to executing `git add . && git rm -rf --ignore-unmatch .`. This step is useful for the common scenario where the entire content of a Stage-specific branch is to be replaced @@ -1607,7 +1607,7 @@ Our request is considered: -This examples is adapted from +This example is adapted from [Slack's own documentation](https://api.slack.com/tutorials/tracks/posting-messages-with-curl): ```yaml diff --git a/docs/docs/40-contributor-guide/10-hacking-on-kargo.md b/docs/docs/40-contributor-guide/10-hacking-on-kargo.md index 6788c824f..59ae98f81 100644 --- a/docs/docs/40-contributor-guide/10-hacking-on-kargo.md +++ b/docs/docs/40-contributor-guide/10-hacking-on-kargo.md @@ -185,7 +185,7 @@ as native processes. [OrbStack](https://orbstack.dev/) is a fast, lightweight, drop-in replacement - for Docker Desktop for Mac OS only. You can follow + for Docker Desktop for macOS only. You can follow [these instructions](https://docs.docker.com/desktop/kubernetes/) to enable its built-in Kubernetes support. @@ -348,7 +348,7 @@ as native processes. Docker Desktop supports only a _single_ Kubernetes cluster. If you are - comfortable deleting not just just Kargo-related resources, but _all_ your + comfortable deleting not just Kargo-related resources, but _all_ your workloads and data, the cluster can be reset from the Docker Desktop Dashboard. @@ -363,7 +363,7 @@ as native processes. OrbStack supports only a _single_ Kubernetes cluster. If you are - comfortable deleting not just just Kargo-related resources, but _all_ your + comfortable deleting not just Kargo-related resources, but _all_ your workloads and data, you can destroy the cluster with: ```shell