From 2ee604b54d9fd6fbf8df972a7734746e6f48d704 Mon Sep 17 00:00:00 2001 From: yukinakanaka Date: Sat, 8 Jul 2023 21:26:39 +0900 Subject: [PATCH] docs: Fixed typo --- docs/basics/authentication.md | 4 ++-- docs/basics/update-methods.md | 4 ++-- docs/basics/update.md | 2 +- docs/install/reference.md | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/basics/authentication.md b/docs/basics/authentication.md index f74b2099..e23c7381 100644 --- a/docs/basics/authentication.md +++ b/docs/basics/authentication.md @@ -1,7 +1,7 @@ # Authentication in Argo CD Image Updater There are several scenarios where Argo CD Image Updater needs to authenticate -to external systems in order to fulfil its duties. +to external systems in order to fulfill its duties. ## Authentication to Kubernetes @@ -207,7 +207,7 @@ echo "someuser:s0mep4ssw0rd" When executing on Kubernetes, the script to be executed must exist in the Image Updater container's file system. You can either mount the script from -a config map, or use an init container to copy it. Make sure that the script +a configmap, or use an init container to copy it. Make sure that the script is executable. For example, if above script would exist at `/usr/local/bin/creds.sh`, it diff --git a/docs/basics/update-methods.md b/docs/basics/update-methods.md index 2a368ea4..1707196c 100644 --- a/docs/basics/update-methods.md +++ b/docs/basics/update-methods.md @@ -3,7 +3,7 @@ ## Overview Argo CD Image Updater supports several methods to propagate new versions of the -images to Argo CD. These methods are also refered to as *write back methods*. +images to Argo CD. These methods are also referred to as *write back methods*. Currently, the following methods are supported: @@ -162,7 +162,7 @@ argocd-image-updater.argoproj.io/git-branch: main ### Specifying a separate base and commit branch -By default, Argo CD Imager Updater will checkout, commit, and push back to the +By default, Argo CD Image Updater will checkout, commit, and push back to the same branch specified above. There are many scenarios where this is not desired or possible, such as when the default branch is protected. You can add a separate write-branch by modifying `argocd-image-updater.argoproj.io/git-branch` diff --git a/docs/basics/update.md b/docs/basics/update.md index 9e23f4a7..623debbb 100644 --- a/docs/basics/update.md +++ b/docs/basics/update.md @@ -18,7 +18,7 @@ The workflow of Argo CD Image Updater can be described as follows: annotation holds a list of image names that should be updated, and is a mandatory annotation for Argo CD Image Updater to indicate it should process this `Application`. Read more about the syntax expected in this - annotations's value in the [marking images for update](#TODO) + annotation's value in the [marking images for update](#TODO) section in this doc. * For each image found in the list, Argo CD Image Updater will first check diff --git a/docs/install/reference.md b/docs/install/reference.md index bfd0b42c..9229ecc5 100644 --- a/docs/install/reference.md +++ b/docs/install/reference.md @@ -123,7 +123,7 @@ Only process applications that have a valid annotation and match the given syntax of `key=value`. For e.g, `custom.label/name=xyz` would be a valid label that can be supplied through this parameter. Any applications carrying this exact label will be considered as candidates for image updates. This parameter -currently does not support patten matching on label values (e.g `customer.label/name=*-staging`) +currently does not support pattern matching on label values (e.g `customer.label/name=*-staging`) and only accepts a single label to match applications against. **--max-concurrency *number* **