From 5c1c633e436663d692828b6141ee1316a8abf336 Mon Sep 17 00:00:00 2001
From: Tetsuya Kikuchi <97105818+t-kikuc@users.noreply.github.com>
Date: Mon, 19 Aug 2024 13:25:07 +0900
Subject: [PATCH] [docs] Add notes about drift detection (#5120)

* add note: `ignoreFields` is available for only K8sApp

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* add prerequisites:  OnOutOfSync.disabled=false

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* fix duplicated

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* fix default

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* link to `trigger-configuration`

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* fix

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

---------

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>
---
 docs/content/en/docs-dev/user-guide/configuration-reference.md  | 2 +-
 .../managing-application/configuration-drift-detection.md       | 2 ++
 .../managing-application/configuration-drift-detection.md       | 2 ++
 .../managing-application/configuration-drift-detection.md       | 2 ++
 .../managing-application/configuration-drift-detection.md       | 2 ++
 .../managing-application/configuration-drift-detection.md       | 2 ++
 .../en/docs-v0.43.x/user-guide/configuration-reference.md       | 2 +-
 .../managing-application/configuration-drift-detection.md       | 2 ++
 .../en/docs-v0.44.x/user-guide/configuration-reference.md       | 2 +-
 .../managing-application/configuration-drift-detection.md       | 2 ++
 .../en/docs-v0.45.x/user-guide/configuration-reference.md       | 2 +-
 .../managing-application/configuration-drift-detection.md       | 2 ++
 .../en/docs-v0.46.x/user-guide/configuration-reference.md       | 2 +-
 .../managing-application/configuration-drift-detection.md       | 2 ++
 .../en/docs-v0.47.x/user-guide/configuration-reference.md       | 2 +-
 .../managing-application/configuration-drift-detection.md       | 2 ++
 .../en/docs-v0.48.x/user-guide/configuration-reference.md       | 2 +-
 .../managing-application/configuration-drift-detection.md       | 2 ++
 18 files changed, 29 insertions(+), 7 deletions(-)

diff --git a/docs/content/en/docs-dev/user-guide/configuration-reference.md b/docs/content/en/docs-dev/user-guide/configuration-reference.md
index 5ec07cf793..40f0f3de92 100644
--- a/docs/content/en/docs-dev/user-guide/configuration-reference.md
+++ b/docs/content/en/docs-dev/user-guide/configuration-reference.md
@@ -807,7 +807,7 @@ Note: By default, the sum of traffic is rounded to 100. If both `primary` and `c
 
 | Field | Type | Description | Required |
 |-|-|-|-|
-| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. | No |
+| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. This is available for only `KubernetesApp`. | No |
 
 ## PipeCD rich defined types
 
diff --git a/docs/content/en/docs-dev/user-guide/managing-application/configuration-drift-detection.md b/docs/content/en/docs-dev/user-guide/managing-application/configuration-drift-detection.md
index 3d2a3b4bc1..6090abf7f5 100644
--- a/docs/content/en/docs-dev/user-guide/managing-application/configuration-drift-detection.md
+++ b/docs/content/en/docs-dev/user-guide/managing-application/configuration-drift-detection.md
@@ -54,6 +54,8 @@ This feature is automatically enabled for all applications.
 
 You can change the checking interval as well as [configure the notification](../../managing-piped/configuring-notifications/) for these events in `piped` configuration.
 
+Note: If you want to trigger deployment automatically when `OUT_OF_SYNC` occurs, see [Trigger configuration](./triggering-a-deployment/#trigger-configuration).
+
 ### Ignore drift detection for specific fields
 
 >  Note: This feature is currently supported for only Kubernetes application.  
diff --git a/docs/content/en/docs-v0.39.x/user-guide/managing-application/configuration-drift-detection.md b/docs/content/en/docs-v0.39.x/user-guide/managing-application/configuration-drift-detection.md
index 9c48ca9305..1049bf866c 100644
--- a/docs/content/en/docs-v0.39.x/user-guide/managing-application/configuration-drift-detection.md
+++ b/docs/content/en/docs-v0.39.x/user-guide/managing-application/configuration-drift-detection.md
@@ -53,3 +53,5 @@ This status means the application is deploying and the configuration drift detec
 This feature is automatically enabled for all applications.
 
 You can change the checking interval as well as [configure the notification](../../managing-piped/configuring-notifications/) for these events in `piped` configuration.
+
+Note: If you want to trigger deployment automatically when `OUT_OF_SYNC` occurs, see [Trigger configuration](./triggering-a-deployment/#trigger-configuration).
diff --git a/docs/content/en/docs-v0.40.x/user-guide/managing-application/configuration-drift-detection.md b/docs/content/en/docs-v0.40.x/user-guide/managing-application/configuration-drift-detection.md
index 9c48ca9305..7e67684dce 100644
--- a/docs/content/en/docs-v0.40.x/user-guide/managing-application/configuration-drift-detection.md
+++ b/docs/content/en/docs-v0.40.x/user-guide/managing-application/configuration-drift-detection.md
@@ -53,3 +53,5 @@ This status means the application is deploying and the configuration drift detec
 This feature is automatically enabled for all applications.
 
 You can change the checking interval as well as [configure the notification](../../managing-piped/configuring-notifications/) for these events in `piped` configuration.
+
+Note: If you want to trigger deployment automatically when `OUT_OF_SYNC` occurs, see [Trigger configuration](./triggering-a-deployment/#trigger-configuration).
\ No newline at end of file
diff --git a/docs/content/en/docs-v0.41.x/user-guide/managing-application/configuration-drift-detection.md b/docs/content/en/docs-v0.41.x/user-guide/managing-application/configuration-drift-detection.md
index 9c48ca9305..7e67684dce 100644
--- a/docs/content/en/docs-v0.41.x/user-guide/managing-application/configuration-drift-detection.md
+++ b/docs/content/en/docs-v0.41.x/user-guide/managing-application/configuration-drift-detection.md
@@ -53,3 +53,5 @@ This status means the application is deploying and the configuration drift detec
 This feature is automatically enabled for all applications.
 
 You can change the checking interval as well as [configure the notification](../../managing-piped/configuring-notifications/) for these events in `piped` configuration.
+
+Note: If you want to trigger deployment automatically when `OUT_OF_SYNC` occurs, see [Trigger configuration](./triggering-a-deployment/#trigger-configuration).
\ No newline at end of file
diff --git a/docs/content/en/docs-v0.42.x/user-guide/managing-application/configuration-drift-detection.md b/docs/content/en/docs-v0.42.x/user-guide/managing-application/configuration-drift-detection.md
index 9c48ca9305..7e67684dce 100644
--- a/docs/content/en/docs-v0.42.x/user-guide/managing-application/configuration-drift-detection.md
+++ b/docs/content/en/docs-v0.42.x/user-guide/managing-application/configuration-drift-detection.md
@@ -53,3 +53,5 @@ This status means the application is deploying and the configuration drift detec
 This feature is automatically enabled for all applications.
 
 You can change the checking interval as well as [configure the notification](../../managing-piped/configuring-notifications/) for these events in `piped` configuration.
+
+Note: If you want to trigger deployment automatically when `OUT_OF_SYNC` occurs, see [Trigger configuration](./triggering-a-deployment/#trigger-configuration).
\ No newline at end of file
diff --git a/docs/content/en/docs-v0.43.x/user-guide/configuration-reference.md b/docs/content/en/docs-v0.43.x/user-guide/configuration-reference.md
index a1838d17d1..ac84d13e74 100644
--- a/docs/content/en/docs-v0.43.x/user-guide/configuration-reference.md
+++ b/docs/content/en/docs-v0.43.x/user-guide/configuration-reference.md
@@ -661,7 +661,7 @@ Note: By default, the sum of traffic is rounded to 100. If both `primary` and `c
 
 | Field | Type | Description | Required |
 |-|-|-|-|
-| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. | No |
+| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. This is available for only `KubernetesApp`.| No |
 
 ## PipeCD rich defined types
 
diff --git a/docs/content/en/docs-v0.43.x/user-guide/managing-application/configuration-drift-detection.md b/docs/content/en/docs-v0.43.x/user-guide/managing-application/configuration-drift-detection.md
index 3d2a3b4bc1..6090abf7f5 100644
--- a/docs/content/en/docs-v0.43.x/user-guide/managing-application/configuration-drift-detection.md
+++ b/docs/content/en/docs-v0.43.x/user-guide/managing-application/configuration-drift-detection.md
@@ -54,6 +54,8 @@ This feature is automatically enabled for all applications.
 
 You can change the checking interval as well as [configure the notification](../../managing-piped/configuring-notifications/) for these events in `piped` configuration.
 
+Note: If you want to trigger deployment automatically when `OUT_OF_SYNC` occurs, see [Trigger configuration](./triggering-a-deployment/#trigger-configuration).
+
 ### Ignore drift detection for specific fields
 
 >  Note: This feature is currently supported for only Kubernetes application.  
diff --git a/docs/content/en/docs-v0.44.x/user-guide/configuration-reference.md b/docs/content/en/docs-v0.44.x/user-guide/configuration-reference.md
index d78c750b81..07f0cf26d4 100644
--- a/docs/content/en/docs-v0.44.x/user-guide/configuration-reference.md
+++ b/docs/content/en/docs-v0.44.x/user-guide/configuration-reference.md
@@ -682,7 +682,7 @@ Note: By default, the sum of traffic is rounded to 100. If both `primary` and `c
 
 | Field | Type | Description | Required |
 |-|-|-|-|
-| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. | No |
+| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. This is available for only `KubernetesApp`.| No |
 
 ## PipeCD rich defined types
 
diff --git a/docs/content/en/docs-v0.44.x/user-guide/managing-application/configuration-drift-detection.md b/docs/content/en/docs-v0.44.x/user-guide/managing-application/configuration-drift-detection.md
index 3d2a3b4bc1..6090abf7f5 100644
--- a/docs/content/en/docs-v0.44.x/user-guide/managing-application/configuration-drift-detection.md
+++ b/docs/content/en/docs-v0.44.x/user-guide/managing-application/configuration-drift-detection.md
@@ -54,6 +54,8 @@ This feature is automatically enabled for all applications.
 
 You can change the checking interval as well as [configure the notification](../../managing-piped/configuring-notifications/) for these events in `piped` configuration.
 
+Note: If you want to trigger deployment automatically when `OUT_OF_SYNC` occurs, see [Trigger configuration](./triggering-a-deployment/#trigger-configuration).
+
 ### Ignore drift detection for specific fields
 
 >  Note: This feature is currently supported for only Kubernetes application.  
diff --git a/docs/content/en/docs-v0.45.x/user-guide/configuration-reference.md b/docs/content/en/docs-v0.45.x/user-guide/configuration-reference.md
index 600bc7ecb9..0c27e7e228 100644
--- a/docs/content/en/docs-v0.45.x/user-guide/configuration-reference.md
+++ b/docs/content/en/docs-v0.45.x/user-guide/configuration-reference.md
@@ -703,7 +703,7 @@ Note: By default, the sum of traffic is rounded to 100. If both `primary` and `c
 
 | Field | Type | Description | Required |
 |-|-|-|-|
-| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. | No |
+| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. This is available for only `KubernetesApp`.| No |
 
 ## PipeCD rich defined types
 
diff --git a/docs/content/en/docs-v0.45.x/user-guide/managing-application/configuration-drift-detection.md b/docs/content/en/docs-v0.45.x/user-guide/managing-application/configuration-drift-detection.md
index 3d2a3b4bc1..6090abf7f5 100644
--- a/docs/content/en/docs-v0.45.x/user-guide/managing-application/configuration-drift-detection.md
+++ b/docs/content/en/docs-v0.45.x/user-guide/managing-application/configuration-drift-detection.md
@@ -54,6 +54,8 @@ This feature is automatically enabled for all applications.
 
 You can change the checking interval as well as [configure the notification](../../managing-piped/configuring-notifications/) for these events in `piped` configuration.
 
+Note: If you want to trigger deployment automatically when `OUT_OF_SYNC` occurs, see [Trigger configuration](./triggering-a-deployment/#trigger-configuration).
+
 ### Ignore drift detection for specific fields
 
 >  Note: This feature is currently supported for only Kubernetes application.  
diff --git a/docs/content/en/docs-v0.46.x/user-guide/configuration-reference.md b/docs/content/en/docs-v0.46.x/user-guide/configuration-reference.md
index 17735d9a85..23ca95b5bb 100644
--- a/docs/content/en/docs-v0.46.x/user-guide/configuration-reference.md
+++ b/docs/content/en/docs-v0.46.x/user-guide/configuration-reference.md
@@ -771,7 +771,7 @@ Note: By default, the sum of traffic is rounded to 100. If both `primary` and `c
 
 | Field | Type | Description | Required |
 |-|-|-|-|
-| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. | No |
+| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. This is available for only `KubernetesApp`.| No |
 
 ## PipeCD rich defined types
 
diff --git a/docs/content/en/docs-v0.46.x/user-guide/managing-application/configuration-drift-detection.md b/docs/content/en/docs-v0.46.x/user-guide/managing-application/configuration-drift-detection.md
index 3d2a3b4bc1..6090abf7f5 100644
--- a/docs/content/en/docs-v0.46.x/user-guide/managing-application/configuration-drift-detection.md
+++ b/docs/content/en/docs-v0.46.x/user-guide/managing-application/configuration-drift-detection.md
@@ -54,6 +54,8 @@ This feature is automatically enabled for all applications.
 
 You can change the checking interval as well as [configure the notification](../../managing-piped/configuring-notifications/) for these events in `piped` configuration.
 
+Note: If you want to trigger deployment automatically when `OUT_OF_SYNC` occurs, see [Trigger configuration](./triggering-a-deployment/#trigger-configuration).
+
 ### Ignore drift detection for specific fields
 
 >  Note: This feature is currently supported for only Kubernetes application.  
diff --git a/docs/content/en/docs-v0.47.x/user-guide/configuration-reference.md b/docs/content/en/docs-v0.47.x/user-guide/configuration-reference.md
index c8c576f8ec..0231d0d44c 100644
--- a/docs/content/en/docs-v0.47.x/user-guide/configuration-reference.md
+++ b/docs/content/en/docs-v0.47.x/user-guide/configuration-reference.md
@@ -792,7 +792,7 @@ Note: By default, the sum of traffic is rounded to 100. If both `primary` and `c
 
 | Field | Type | Description | Required |
 |-|-|-|-|
-| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. | No |
+| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. This is available for only `KubernetesApp`.| No |
 
 ## PipeCD rich defined types
 
diff --git a/docs/content/en/docs-v0.47.x/user-guide/managing-application/configuration-drift-detection.md b/docs/content/en/docs-v0.47.x/user-guide/managing-application/configuration-drift-detection.md
index 3d2a3b4bc1..6090abf7f5 100644
--- a/docs/content/en/docs-v0.47.x/user-guide/managing-application/configuration-drift-detection.md
+++ b/docs/content/en/docs-v0.47.x/user-guide/managing-application/configuration-drift-detection.md
@@ -54,6 +54,8 @@ This feature is automatically enabled for all applications.
 
 You can change the checking interval as well as [configure the notification](../../managing-piped/configuring-notifications/) for these events in `piped` configuration.
 
+Note: If you want to trigger deployment automatically when `OUT_OF_SYNC` occurs, see [Trigger configuration](./triggering-a-deployment/#trigger-configuration).
+
 ### Ignore drift detection for specific fields
 
 >  Note: This feature is currently supported for only Kubernetes application.  
diff --git a/docs/content/en/docs-v0.48.x/user-guide/configuration-reference.md b/docs/content/en/docs-v0.48.x/user-guide/configuration-reference.md
index ef6a15ccb6..fd7333915f 100644
--- a/docs/content/en/docs-v0.48.x/user-guide/configuration-reference.md
+++ b/docs/content/en/docs-v0.48.x/user-guide/configuration-reference.md
@@ -803,7 +803,7 @@ Note: By default, the sum of traffic is rounded to 100. If both `primary` and `c
 
 | Field | Type | Description | Required |
 |-|-|-|-|
-| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. | No |
+| ignoreFields | []string | List of fields path in manifests, which its diff should be ignored. This is available for only `KubernetesApp`.| No |
 
 ## PipeCD rich defined types
 
diff --git a/docs/content/en/docs-v0.48.x/user-guide/managing-application/configuration-drift-detection.md b/docs/content/en/docs-v0.48.x/user-guide/managing-application/configuration-drift-detection.md
index 3d2a3b4bc1..6090abf7f5 100644
--- a/docs/content/en/docs-v0.48.x/user-guide/managing-application/configuration-drift-detection.md
+++ b/docs/content/en/docs-v0.48.x/user-guide/managing-application/configuration-drift-detection.md
@@ -54,6 +54,8 @@ This feature is automatically enabled for all applications.
 
 You can change the checking interval as well as [configure the notification](../../managing-piped/configuring-notifications/) for these events in `piped` configuration.
 
+Note: If you want to trigger deployment automatically when `OUT_OF_SYNC` occurs, see [Trigger configuration](./triggering-a-deployment/#trigger-configuration).
+
 ### Ignore drift detection for specific fields
 
 >  Note: This feature is currently supported for only Kubernetes application.