Skip to content

Commit 516a659

Browse files
author
Tim Bannister
committed
Tweak docs about docs for features
- Clarify a few details about feature gate metadata - Clean up some whitespace
1 parent fb018ce commit 516a659

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

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

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ should look like. Usually a single paragraph is enough; for longer explanations,
138138
add documentation elsewhere and link to that.
139139

140140
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
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
142142
in the [front matter](https://gohugo.io/content-management/front-matter/) of your Markdown
143143
description file:
144144

@@ -155,20 +155,20 @@ 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-
When you change a feature gate to disabled-by-default to enabled-by-default,
158+
When you change a feature gate from disabled-by-default to enabled-by-default,
159159
you may also need to change other documentation (not just the list of
160160
feature gates). Watch out for language such as ”The `exampleSetting` field
161161
is a beta field and disabled by default. You can enable it by enabling the
162162
`ProcessExampleThings` feature gate.”
163163

164-
If your feature is GA'ed or deprecated,
165-
include an additional `stage` entry within the `stages` block in the description file.
166-
Ensure that the Alpha and Beta stages remain intact.
167-
This step transitions the feature gate from the
164+
If your feature is GA'ed or deprecated, include an additional `stage` entry within
165+
the `stages` block in the description file.
166+
Ensure that the Alpha and Beta stages remain intact. This step transitions the
167+
feature gate from the
168168
[Feature gates for Alpha/Feature](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features) table
169169
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:
170170

171-
{{< highlight yaml "linenos=false,hl_lines=10-15" >}}
171+
{{< highlight yaml "linenos=false,hl_lines=10-17" >}}
172172
stages:
173173
- stage: alpha
174174
defaultValue: false
@@ -177,18 +177,19 @@ stages:
177177
- stage: beta
178178
defaultValue: true
179179
fromVersion: "1.13"
180-
toVersion: "1.18"
181-
# Added 'stable' stage block to existing stages.
182-
- stage: stable
180+
# Added a `toVersion` to the previous stage.
181+
toVersion: "1.18"
182+
# Added 'stable' stage block to existing stages.
183+
- stage: stable
183184
defaultValue: true
184185
fromVersion: "1.19"
185-
toVersion: "1.27"
186+
toVersion: "1.27"
186187
{{< / highlight >}}
187188

188-
Eventually, Kubernetes will stop including the feature gate at all. To signify the removal of a feature gate,
189+
Eventually, Kubernetes will stop including the feature gate at all. To signify the removal of a feature gate,
189190
include `removed: true` in the front matter of the respective description file.
190-
This action triggers the transition of the feature gate
191-
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
191+
Making that change means that the feature gate information moves from
192+
the [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
192193
[Feature Gates (removed)](/docs/reference/command-line-tools-reference/feature-gates-removed/), including its description.
193194

194195
### All PRs reviewed and ready to merge

0 commit comments

Comments
 (0)