Skip to content

Commit e58c873

Browse files
Oreoxmtqiancai
andauthored
Apply suggestions from code review
Co-authored-by: Grace Cai <qqzczy@126.com>
1 parent 521e7a6 commit e58c873

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

en/feature-gates.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ summary: Learn how to use feature gates to enable or disable specific features i
55

66
# Feature Gates
77

8-
Feature gates are configuration switches that enable or disable specific features in TiDB Operator. These features are typically experimental, and enabling them might require restarting certain cluster components.
8+
Feature gates are configuration switches that enable or disable specific features in TiDB Operator. These features are generally experimental, and enabling them might require restarting certain components for the changes to take effect.
99

1010
You can configure feature gates in the `spec.featureGates` field of the Cluster Custom Resource (CR). The following example shows how to enable the `FeatureModification` feature gate:
1111

@@ -17,7 +17,7 @@ spec:
1717
1818
## Supported feature gates
1919
20-
This section describes the feature gates supported by TiDB Operator. For the definition of feature stages, see [Feature gate stages](#feature-gate-stages).
20+
This section describes the feature gates supported by TiDB Operator. For definitions of feature stages, see [Feature gate stages](#feature-gate-stages).
2121
2222
### `FeatureModification`
2323

@@ -56,16 +56,16 @@ This section describes the feature gates supported by TiDB Operator. For the def
5656

5757
## Feature gate stages
5858

59-
TiDB Operator classifies feature gates into three stages based on maturity: Alpha, Beta, and GA.
59+
TiDB Operator classifies feature gates into three stages based on feature maturity: Alpha, Beta, and GA.
6060

6161
### Alpha
6262

6363
Alpha-stage features have the following characteristics:
6464

6565
- Disabled by default.
66-
- Recommended for use only in newly created clusters.
66+
- Recommended only for newly created clusters.
6767
- Dynamic enabling or disabling in existing clusters is not guaranteed.
68-
- Known or unknown issues might occur after enabling.
68+
- Known or unknown issues might occur after being enabled.
6969
- **Not recommended for production environments** unless risks are fully evaluated and validated.
7070

7171
### Beta
@@ -74,12 +74,12 @@ Beta-stage features have the following characteristics:
7474

7575
- Typically have undergone thorough testing.
7676
- Recommended to enable in all newly created clusters.
77-
- Usually support enabling or disabling on existing clusters, but might require restarting related components.
77+
- Usually support enabling or disabling in existing clusters, but might require restarting related components.
7878

7979
### GA
8080

8181
GA (General Availability) features have the following characteristics:
8282

8383
- Typically have undergone long-term and large-scale testing.
8484
- Enabled by default.
85-
- Cannot be disabled.
85+
- Cannot be disabled using feature gates.

zh/feature-gates.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ summary: 介绍如何使用特性门控 (Feature Gates) 在 TiDB 集群中开启
55

66
# 特性门控
77

8-
特性门控 (Feature Gates) 是一组开关,用于控制 TiDB Operator 中特定功能的启用状态。这些功能通常处于实验阶段,启用后可能需要重启部分组件
8+
特性门控 (Feature Gates) 是一组开关,用于控制是否启用 TiDB Operator 中的特定功能。这些功能通常处于实验阶段,启用后可能需要重启部分组件才能生效
99

1010
你可以在 Cluster CR 的 `spec.featureGates` 字段中配置特性门控。以下示例展示如何启用 `FeatureModification` 特性:
1111

@@ -82,4 +82,4 @@ GA (General Availability) 阶段的特性具有以下特点:
8282

8383
- 通常已经过长期和大规模测试。
8484
- 默认开启。
85-
- 不支持关闭
85+
- 不支持通过特性门控关闭

0 commit comments

Comments
 (0)