Skip to content

Commit 91e688c

Browse files
authored
Merge pull request #25199 from annajung/modify-release-doc-instruction
Update documenting a feature for a release doc
2 parents d77eabb + 1890273 commit 91e688c

File tree

1 file changed

+18
-13
lines changed

1 file changed

+18
-13
lines changed

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

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -95,14 +95,16 @@ deadlines.
9595

9696
### Open a placeholder PR
9797

98-
1. Open a pull request against the
98+
1. Open a **draft** pull request against the
9999
`dev-{{< skew nextMinorVersion >}}` branch in the `kubernetes/website` repository, with a small
100-
commit that you will amend later.
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**.
101103
2. Edit the pull request description to include links to [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes)
102104
PR(s) and [kubernetes/enhancements](https://github.com/kubernetes/enhancements) issue(s).
103-
3. Use the Prow command `/milestone {{< skew nextMinorVersion >}}` to
104-
assign the PR to the relevant milestone. This alerts the docs person managing
105-
this release that the feature docs are coming.
105+
3. 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.
106108

107109
If your feature does not need
108110
any documentation changes, make sure the sig-release team knows this, by
@@ -112,14 +114,23 @@ milestone.
112114

113115
### PR ready for review
114116

115-
When ready, populate your placeholder PR with feature documentation.
117+
When ready, populate your placeholder PR with feature documentation and change
118+
the state of the PR from draft to **ready for review**. To mark a pull request
119+
as ready for review, navigate to the merge box and click **Ready for review**.
116120

117121
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.
118122

119123
When you complete your content, the documentation person assigned to your feature reviews it.
120124
To ensure technical accuracy, the content may also require a technical review from corresponding SIG(s).
121125
Use their suggestions to get the content to a release ready state.
122126

127+
If your feature is an Alpha or Beta feature and is behind a feature gate,
128+
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)
129+
table as part of your pull request. With new feature gates, a description of
130+
the feature gate is also required. If your feature is GA'ed or deprecated,
131+
make sure to move it from that table to [Feature gates for graduated or deprecated features](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-graduated-or-deprecated-features)
132+
table with Alpha and Beta history intact.
133+
123134
If your feature needs documentation and the first draft
124135
content is not received, the feature may be removed from the milestone.
125136

@@ -128,10 +139,4 @@ content is not received, the feature may be removed from the milestone.
128139
If your PR has not yet been merged into the `dev-{{< skew nextMinorVersion >}}` branch by the release deadline, work with the
129140
docs person managing the release to get it in by the deadline. If your feature needs
130141
documentation and the docs are not ready, the feature may be removed from the
131-
milestone.
132-
133-
If your feature is an Alpha feature and is behind a feature gate, make sure you
134-
add it to [Alpha/Beta Feature gates](/docs/reference/command-line-tools-reference/feature-gates/#feature-gates-for-alpha-or-beta-features) table
135-
as part of your pull request. If your feature is moving out of Alpha, make sure to
136-
remove it from that table.
137-
142+
milestone.

0 commit comments

Comments
 (0)