Skip to content

Commit dacb5a8

Browse files
authored
Merge pull request #24571 from annajung/master
Add a technical review requirement for feature documentation
2 parents ad35d64 + edac0b3 commit dacb5a8

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,8 @@ deadlines.
9898
1. Open a pull request against the
9999
`dev-{{< skew nextMinorVersion >}}` branch in the `kubernetes/website` repository, with a small
100100
commit that you will amend later.
101-
2. Edit the pull request description to include links to `k/k` PR(s) and `k/enhancement` issue(s).
101+
2. Edit the pull request description to include links to [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes)
102+
PR(s) and [kubernetes/enhancements](https://github.com/kubernetes/enhancements) issue(s).
102103
3. Use the Prow command `/milestone {{< skew nextMinorVersion >}}` to
103104
assign the PR to the relevant milestone. This alerts the docs person managing
104105
this release that the feature docs are coming.
@@ -115,7 +116,9 @@ When ready, populate your placeholder PR with feature documentation.
115116

116117
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.
117118

118-
When you complete your content, the documentation person assigned to your feature reviews it. Use their suggestions to get the content to a release ready state.
119+
When you complete your content, the documentation person assigned to your feature reviews it.
120+
To ensure technical accuracy, the content may also require a technical review from corresponding SIG(s).
121+
Use their suggestions to get the content to a release ready state.
119122

120123
If your feature needs documentation and the first draft
121124
content is not received, the feature may be removed from the milestone.

0 commit comments

Comments
 (0)