You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by ch...@apache.org on 2022/06/14 11:38:49 UTC
[flink] 02/02: [hotfix][docs] Improve HA_MODE description
This is an automated email from the ASF dual-hosted git repository.
chesnay pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 92209b2ce6c9b46bc7f9158f8e549eedd29cd78a
Author: Chesnay Schepler <ch...@apache.org>
AuthorDate: Mon Jun 13 15:04:10 2022 +0200
[hotfix][docs] Improve HA_MODE description
---
.../shortcodes/generated/common_high_availability_section.html | 2 +-
.../shortcodes/generated/high_availability_configuration.html | 2 +-
.../org/apache/flink/configuration/HighAvailabilityOptions.java | 6 +++---
3 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/docs/layouts/shortcodes/generated/common_high_availability_section.html b/docs/layouts/shortcodes/generated/common_high_availability_section.html
index d4a7463b6aa..23a20d6845a 100644
--- a/docs/layouts/shortcodes/generated/common_high_availability_section.html
+++ b/docs/layouts/shortcodes/generated/common_high_availability_section.html
@@ -12,7 +12,7 @@
<td><h5>high-availability</h5></td>
<td style="word-wrap: break-word;">"NONE"</td>
<td>String</td>
- <td>Defines high-availability mode used for the cluster execution. To enable high-availability, set this mode to "ZOOKEEPER", "KUBERNETES" or specify FQN of factory class.</td>
+ <td>Defines high-availability mode used for cluster execution. To enable high-availability, set this mode to "ZOOKEEPER", "KUBERNETES", or specify the fully qualified name of the factory class.</td>
</tr>
<tr>
<td><h5>high-availability.cluster-id</h5></td>
diff --git a/docs/layouts/shortcodes/generated/high_availability_configuration.html b/docs/layouts/shortcodes/generated/high_availability_configuration.html
index 1c93975923c..8c8c61e43b5 100644
--- a/docs/layouts/shortcodes/generated/high_availability_configuration.html
+++ b/docs/layouts/shortcodes/generated/high_availability_configuration.html
@@ -12,7 +12,7 @@
<td><h5>high-availability</h5></td>
<td style="word-wrap: break-word;">"NONE"</td>
<td>String</td>
- <td>Defines high-availability mode used for the cluster execution. To enable high-availability, set this mode to "ZOOKEEPER", "KUBERNETES" or specify FQN of factory class.</td>
+ <td>Defines high-availability mode used for cluster execution. To enable high-availability, set this mode to "ZOOKEEPER", "KUBERNETES", or specify the fully qualified name of the factory class.</td>
</tr>
<tr>
<td><h5>high-availability.cluster-id</h5></td>
diff --git a/flink-core/src/main/java/org/apache/flink/configuration/HighAvailabilityOptions.java b/flink-core/src/main/java/org/apache/flink/configuration/HighAvailabilityOptions.java
index 97606c5679e..12826d1e84d 100644
--- a/flink-core/src/main/java/org/apache/flink/configuration/HighAvailabilityOptions.java
+++ b/flink-core/src/main/java/org/apache/flink/configuration/HighAvailabilityOptions.java
@@ -34,7 +34,7 @@ public class HighAvailabilityOptions {
/**
* Defines high-availability mode used for the cluster execution. A value of "NONE" signals no
* highly available setup. To enable high-availability, set this mode to "ZOOKEEPER" or
- * "KUBERNETES". Can also be set to FQN of HighAvailability factory class.
+ * "KUBERNETES". Can also be set to the FQN of the HighAvailability factory class.
*/
@Documentation.Section(Documentation.Sections.COMMON_HIGH_AVAILABILITY)
public static final ConfigOption<String> HA_MODE =
@@ -43,8 +43,8 @@ public class HighAvailabilityOptions {
.defaultValue("NONE")
.withDeprecatedKeys("recovery.mode")
.withDescription(
- "Defines high-availability mode used for the cluster execution."
- + " To enable high-availability, set this mode to \"ZOOKEEPER\", \"KUBERNETES\" or specify FQN of factory class.");
+ "Defines high-availability mode used for cluster execution."
+ + " To enable high-availability, set this mode to \"ZOOKEEPER\", \"KUBERNETES\", or specify the fully qualified name of the factory class.");
/**
* The ID of the Flink cluster, used to separate multiple Flink clusters Needs to be set for