You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If your feature is an Alpha or Beta feature and is behind a feature gate,
132
-
make sure you add it to [Alpha/Beta Feature gates](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features)
133
-
table as part of your pull request. With net new feature gates, a separate
The name of the file should be the feature gate, converted from `UpperCamelCase`
135
+
to `kebab-case`, with `.md` as the suffix.
136
+
You can look at other files already in the same directory for a hint about what yours
137
+
should look like. Usually a single paragraph is enough; for longer explanations,
138
+
add documentation elsewhere and link to that.
139
+
140
+
Also,
141
+
to ensure your feature gate appears in the [Alpha/Beta Feature gates](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features) table, include the following details
142
+
in the [front matter](https://gohugo.io/content-management/front-matter/) of your Markdown
143
+
description file:
144
+
145
+
```yaml
146
+
stages:
147
+
- stage: <alpha/beta/stable/deprecated> # Specify the development stage of the feature gate
148
+
defaultValue: <true or false> # Set to true if enabled by default, false otherwise
149
+
fromVersion: <Version> # Version from which the feature gate is available
150
+
toVersion: <Version> # (Optional) The version until which the feature gate is available
151
+
```
152
+
153
+
With net new feature gates, a separate
134
154
description of the feature gate is also required; create a new Markdown file
@@ -147,14 +167,35 @@ feature gates). Watch out for language such as ”The `exampleSetting` field
147
167
is a beta field and disabled by default. You can enable it by enabling the
148
168
`ProcessExampleThings`feature gate.”
149
169
150
-
If your feature is GA'ed or deprecated, make sure to move it from the
170
+
If your feature is GA'ed or deprecated,
171
+
include an additional `stage` entry within the `stages` block in the description file.
172
+
Ensure that the Alpha and Beta stages remain intact.
173
+
This step transitions the feature gate from the
151
174
[Feature gates for Alpha/Feature](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features) table
152
-
to [Feature gates for graduated or deprecated features](/docs/reference/command-line-tools-reference/feature-gates-removed/#feature-gates-that-are-removed)
153
-
table with Alpha and Beta history intact.
154
-
155
-
Eventually, Kubernetes will stop including the feature gate at all.
156
-
In that case, you move it from [Feature gates for graduated or deprecated features](/docs/reference/command-line-tools-reference/feature-gates-removed/#feature-gates-that-are-removed)
157
-
and into a separate page, [Feature Gates (removed)](/docs/reference/command-line-tools-reference/feature-gates-removed/).
175
+
to [Feature gates for graduated or deprecated features](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-graduated-or-deprecated-features) table. For example:
Eventually, Kubernetes will stop including the feature gate at all. To signify the removal of a feature gate,
195
+
include `removed: true` in the front matter of the respective description file.
196
+
This action triggers the transition of the feature gate
197
+
from [Feature gates for graduated or deprecated features](/docs/reference/command-line-tools-reference/feature-gates-removed/#feature-gates-that-are-removed) section to a dedicated page titled
0 commit comments