kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add a technical review requirement for feature documentation

This commit is contained in:
Anna Jung 2020-10-14 10:49:26 -05:00
parent ad35d64797
commit a2e9bddd90
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
content/en/docs/contribute/new-content/new-features.md
View File

@ -98,7 +98,7 @@ deadlines.
1. Open a pull request against the 1. Open a pull request against the
`dev-{{< skew nextMinorVersion >}}` branch in the `kubernetes/website` repository, with a small `dev-{{< skew nextMinorVersion >}}` branch in the `kubernetes/website` repository, with a small
commit that you will amend later. commit that you will amend later.
2. Edit the pull request description to include links to `k/k` PR(s) and `k/enhancement` issue(s). 2. Edit the pull request description to include links to `kubernetes/kubernetes` PR(s) and `kubernetes/enhancement` issue(s).
3. Use the Prow command `/milestone {{< skew nextMinorVersion >}}` to 3. Use the Prow command `/milestone {{< skew nextMinorVersion >}}` to
assign the PR to the relevant milestone. This alerts the docs person managing assign the PR to the relevant milestone. This alerts the docs person managing
this release that the feature docs are coming. this release that the feature docs are coming.
@ -115,7 +115,9 @@ When ready, populate your placeholder PR with feature documentation.
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. 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.
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. When you complete your content, the documentation person assigned to your feature reviews it.
To ensure technical accuracy, the content may also require a technical review from corresponding SIG(s).
Use their suggestions to get the content to a release ready state.
If your feature needs documentation and the first draft If your feature needs documentation and the first draft
content is not received, the feature may be removed from the milestone. content is not received, the feature may be removed from the milestone.