From a2e9bddd90ac076bb65492de2117082d9d2af3cc Mon Sep 17 00:00:00 2001 From: Anna Jung Date: Wed, 14 Oct 2020 10:49:26 -0500 Subject: [PATCH 1/2] Add a technical review requirement for feature documentation --- content/en/docs/contribute/new-content/new-features.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/content/en/docs/contribute/new-content/new-features.md b/content/en/docs/contribute/new-content/new-features.md index 98823185ff..8826a6eb9e 100644 --- a/content/en/docs/contribute/new-content/new-features.md +++ b/content/en/docs/contribute/new-content/new-features.md @@ -98,7 +98,7 @@ deadlines. 1. Open a pull request against the `dev-{{< skew nextMinorVersion >}}` branch in the `kubernetes/website` repository, with a small 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 assign the PR to the relevant milestone. This alerts the docs person managing 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. -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 content is not received, the feature may be removed from the milestone. From edac0b3c2e64fafd7faf2866c4d38ce268c92f43 Mon Sep 17 00:00:00 2001 From: Anna Jung Date: Wed, 14 Oct 2020 12:15:40 -0500 Subject: [PATCH 2/2] Modify to change repo names to hyperlinks --- content/en/docs/contribute/new-content/new-features.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/en/docs/contribute/new-content/new-features.md b/content/en/docs/contribute/new-content/new-features.md index 8826a6eb9e..4e70f6c9ec 100644 --- a/content/en/docs/contribute/new-content/new-features.md +++ b/content/en/docs/contribute/new-content/new-features.md @@ -98,7 +98,8 @@ deadlines. 1. Open a pull request against the `dev-{{< skew nextMinorVersion >}}` branch in the `kubernetes/website` repository, with a small commit that you will amend later. -2. Edit the pull request description to include links to `kubernetes/kubernetes` PR(s) and `kubernetes/enhancement` issue(s). +2. Edit the pull request description to include links to [kubernetes/kubernetes](https://github.com/kubernetes/kubernetes) +PR(s) and [kubernetes/enhancements](https://github.com/kubernetes/enhancements) issue(s). 3. Use the Prow command `/milestone {{< skew nextMinorVersion >}}` to assign the PR to the relevant milestone. This alerts the docs person managing this release that the feature docs are coming.