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
Copy file name to clipboardExpand all lines: content/en/docs/contribute/new-content/new-features.md
+36-29Lines changed: 36 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,16 +11,16 @@ card:
11
11
---
12
12
<!-- overview -->
13
13
14
-
Each major Kubernetes release introduces new features that require documentation. New releases also bring updates to existing features and documentation (such as upgrading a feature from alpha to beta).
14
+
Each major Kubernetes release introduces new features that require documentation.
15
+
New releases also bring updates to existing features and documentation
16
+
(such as upgrading a feature from alpha to beta).
15
17
16
18
Generally, the SIG responsible for a feature submits draft documentation of the
17
19
feature as a pull request to the appropriate development branch of the
18
20
`kubernetes/website` repository, and someone on the SIG Docs team provides
19
21
editorial feedback or edits the draft directly. This section covers the branching
20
22
conventions and process used during a release by both groups.
21
23
22
-
23
-
24
24
<!-- body -->
25
25
26
26
## For documentation contributors
@@ -40,7 +40,8 @@ To find out about upcoming features, attend the weekly SIG Release meeting (see
40
40
the [community](/community/) page for upcoming meetings)
41
41
and monitor the release-specific documentation
42
42
in the [kubernetes/sig-release](https://github.com/kubernetes/sig-release/)
43
-
repository. Each release has a sub-directory in the [/sig-release/tree/master/releases/](https://github.com/kubernetes/sig-release/tree/master/releases)
43
+
repository. Each release has a sub-directory in the
directory. The sub-directory contains a release schedule, a draft of the release
45
46
notes, and a document listing each person on the release team.
46
47
@@ -95,15 +96,15 @@ deadlines.
95
96
### Open a placeholder PR
96
97
97
98
1. Open a **draft** pull request against the
98
-
`dev-{{< skew nextMinorVersion >}}` branch in the `kubernetes/website` repository, with a small
99
-
commit that you will amend later. To create a draft pull request, use the
100
-
Create Pull Request drop-down and select **Create Draft Pull Request**,
101
-
then click **Draft Pull Request**.
102
-
2. Edit the pull request description to include links to [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes)
103
-
PR(s) and [kubernetes/enhancements](https://github.com/kubernetes/enhancements) issue(s).
104
-
3. Leave a comment on the related [kubernetes/enhancements](https://github.com/kubernetes/enhancements)
105
-
issue with a link to the PR to notify the docs person managing this release that
106
-
the feature docs are coming and should be tracked for the release.
99
+
`dev-{{< skew nextMinorVersion >}}` branch in the `kubernetes/website` repository, with a small
100
+
commit that you will amend later. To create a draft pull request, use the
101
+
**Create Pull Request** drop-down and select **Create Draft Pull Request**,
102
+
then click **Draft Pull Request**.
103
+
1. Edit the pull request description to include links to [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes)
104
+
PR(s) and [kubernetes/enhancements](https://github.com/kubernetes/enhancements) issue(s).
105
+
1. Leave a comment on the related [kubernetes/enhancements](https://github.com/kubernetes/enhancements)
106
+
issue with a link to the PR to notify the docs person managing this release that
107
+
the feature docs are coming and should be tracked for the release.
107
108
108
109
If your feature does not need
109
110
any documentation changes, make sure the sig-release team knows this, by
@@ -117,7 +118,8 @@ When ready, populate your placeholder PR with feature documentation and change
117
118
the state of the PR from draft to **ready for review**. To mark a pull request
118
119
as ready for review, navigate to the merge box and click **Ready for review**.
119
120
120
-
Do your best to describe your feature and how to use it. If you need help structuring your documentation, ask in the `#sig-docs` Slack channel.
121
+
Do your best to describe your feature and how to use it. If you need help
122
+
structuring your documentation, ask in the `#sig-docs` Slack channel.
121
123
122
124
When you complete your content, the documentation person assigned to your feature reviews it.
123
125
To ensure technical accuracy, the content may also require a technical review from corresponding SIG(s).
@@ -137,10 +139,11 @@ You can look at other files already in the same directory for a hint about what
137
139
should look like. Usually a single paragraph is enough; for longer explanations,
138
140
add documentation elsewhere and link to that.
139
141
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
@@ -165,8 +168,9 @@ If your feature is GA'ed or deprecated, include an additional `stage` entry with
165
168
the `stages` block in the description file.
166
169
Ensure that the Alpha and Beta stages remain intact. This step transitions the
167
170
feature gate from the
168
-
[Feature gates for Alpha/Feature](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features) table
169
-
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:
171
+
[Feature gates for Alpha/Beta](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features) table
172
+
to [Feature gates for graduated or deprecated features](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-graduated-or-deprecated-features)
Eventually, Kubernetes will stop including the feature gate at all. To signify the removal of a feature gate,
190
-
include `removed: true` in the front matter of the respective description file.
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
193
-
[Feature Gates (removed)](/docs/reference/command-line-tools-reference/feature-gates-removed/), including its description.
193
+
Eventually, Kubernetes will stop including the feature gate at all.
194
+
To signify the removal of a feature gate, include `removed: true` in
195
+
the front matter of the respective description file.
196
+
Making that change means that the feature gate information moves from the
197
+
[Feature gates for graduated or deprecated features](/docs/reference/command-line-tools-reference/feature-gates-removed/#feature-gates-that-are-removed)
0 commit comments