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.

Sign up for GitHub

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

chore(backport release-1.2): docs: various small fixes #3274

Merged
merged 1 commit into from
Jan 14, 2025
Merged

chore(backport release-1.2): docs: various small fixes #3274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions docs/docs/20-quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ curl -L https://raw.githubusercontent.com/akuity/kargo/main/hack/quickstart/inst
<TabItem value="orbstack" label="OrbStack">

[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.

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -929,7 +929,7 @@ Now let's clean up!
<TabItem value="docker-desktop" label="Docker Desktop">

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.

Expand All @@ -944,7 +944,7 @@ curl -L https://raw.githubusercontent.com/akuity/kargo/main/hack/quickstart/unin
<TabItem value="orbstack" label="OrbStack">

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
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/30-how-to-guides/20-managing-credentials.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/30-how-to-guides/25-argo-cd-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/35-references/10-promotion-steps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -1607,7 +1607,7 @@ Our request is considered:

<TabItem value="slack" label="Posting to Slack">

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
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/40-contributor-guide/10-hacking-on-kargo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ as native processes.
<TabItem value="orbstack" label="OrbStack">

[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.

Expand Down Expand Up @@ -348,7 +348,7 @@ as native processes.
<TabItem value="docker-desktop" label="Docker Desktop">

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.

Expand All @@ -363,7 +363,7 @@ as native processes.
<TabItem value="orbstack" label="OrbStack">

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
Expand Down
Loading