Skip to content

Commit 98c5caf

Browse files
author
Tim Bannister
committed
Revise guidance about documenting feature gate changes
1 parent daecef8 commit 98c5caf

File tree

1 file changed

+1
-11
lines changed

1 file changed

+1
-11
lines changed

content/en/docs/contribute/new-content/new-features.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -155,12 +155,6 @@ description of the feature gate is also required; create a new Markdown file
155155
inside `content/en/docs/reference/command-line-tools-reference/feature-gates/`
156156
(use other files as a template).
157157

158-
{{< note >}}
159-
Make sure to add a
160-
[`feature-gate-description` shortcode](/docs/contribute/style/hugo-shortcodes/#feature-gate-description)
161-
into the feature gates page. The list is sorted alphabetically.
162-
{{< /note >}}
163-
164158
When you change a feature gate to disabled-by-default to enabled-by-default,
165159
you may also need to change other documentation (not just the list of
166160
feature gates). Watch out for language such as ”The `exampleSetting` field
@@ -195,11 +189,7 @@ Eventually, Kubernetes will stop including the feature gate at all. To signify t
195189
include `removed: true` in the front matter of the respective description file.
196190
This action triggers the transition of the feature gate
197191
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
198-
[Feature Gates (removed)](/docs/reference/command-line-tools-reference/feature-gates-removed/).
199-
200-
Also make sure to move the relevant list entry and
201-
[`feature-gate-description` shortcode](/docs/contribute/style/hugo-shortcodes/#feature-gate-description) into the
202-
removed feature gates page. The lists are sorted alphabetically.
192+
[Feature Gates (removed)](/docs/reference/command-line-tools-reference/feature-gates-removed/), including its description.
203193

204194
### All PRs reviewed and ready to merge
205195

0 commit comments

Comments
 (0)