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

Fixed whats next section in TOC and SME

reviewable/pr1860/r2
a-mccarthy 2016-12-09 14:15:28 -05:00 committed by GitHub
parent 3e6493cf46
commit 4ed6b4e6f4
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/contribute/review-issues.md
View File

@ -8,7 +8,7 @@ This page explains how you should review and prioritize documentation issues mad
{% capture body %}
## Categorizing issues
### Categorizing issues
Issues should be sorted into different buckets of work using the following labels and definitions. If an issue doesn't have enough information to identify a problem that can be researched, reviewed, or worked on (i.e. the issue doesn't fit into any of the categories below) you should close the issue with a comment explaining why it is being closed.
@ -18,7 +18,7 @@ Issues should be sorted into different buckets of work using the following label
#### Tech Review Needed
* Issues that need more information in order to be worked on (the proposed solution needs to be proven, a SME needs to be involved, work needs to be done to understand the problem/resolution and if the issue is still relevant)
* Issues that need more information in order to be worked on (the proposed solution needs to be proven, a subject matter expert needs to be involved, work needs to be done to understand the problem/resolution and if the issue is still relevant)
* Promotes transparency about level of work needed for the issue and that issue is in progress
#### Docs Review Needed
@ -26,7 +26,7 @@ Issues should be sorted into different buckets of work using the following label
* Topics can be brought to SIG meetings as agenda items
## Prioritizing Issues
### Prioritizing Issues
The following labels and definitions should be used to prioritize issues. If you change the priority of an issues, please comment on the issue with your reasoning for the change.
#### P1
@ -45,12 +45,12 @@ The following labels and definitions should be used to prioritize issues. If you
#### P3
* Typos and broken anchor links
## Handling special issue types
### Handling special issue types
### Duplicate issues
#### Duplicate issues
If a single problem has one or more issues open for it, the problem should be consolodated into a single issue. You should decide which issue to keep open (or open a new issue), port over all relevant information, link related issues, and close all the other issues that describe the same problem. Only having a single issue to work on will help reduce confusion and avoid duplicating work on the same problem.
### Dead link issues
#### Dead link issues
Depending on where the dead link is reported, different actions are required to resolve the issue. Dead links in the API and Kubectl docs are automation issues and should be assigned a P1 until the problem can be fully understood. All other dead links are issues that need to be manually fixed and can be assigned a P3.
{% endcapture %}