whentimeslows/website
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update review-issues.md

Browse Source 
Some edits for clarity and condensed language.
This commit is contained in:
Zach Corleissen
2017-10-20 15:39:47 -05:00
committed by zacharysarah
parent 536f927d52
commit b34002b15f
1 changed files with 5 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/home/contribute/review-issues.md
+5 -10
View File
@@ -13,7 +13,7 @@ This page explains how documentation issues are reviewed and prioritized for the
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.
### Needs Clarification
* Issues that need more information from the original submitter to make them actionable. Issues with this label that aren't followed up within a week may be closed.
* Issues that need more information from the original submitter to make them actionable. Issues with this label that aren't followed up within a week may be closed.
### Actionable
* Issues that can be worked on with current information (or may need a comment to explain what needs to be done to make it more clear)
@@ -32,7 +32,6 @@ Issues should be sorted into different buckets of work using the following label
* Issues that are suggestions for improving the user interface of the site.
* Fixing broken site elements.
## 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.
@@ -61,14 +60,12 @@ If a single problem has one or more issues open for it, the problem should be co
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.
### Support requests or code bug reports
Some issues that are opened for docs are actually issues with the underlying code, or requests for assistance when something (such as a tutorial) didn't work. Since these issues aren't related to documentation requests or problems, it is appropriate to respond directing the requester to potential support avenues, and if relevant, where an appropriate issue can be filed if the problem is a bug report.
Some issues opened for docs are instead issues with the underlying code, or requests for assistance when something (like a tutorial) didn't work. For issues unrelated to docs, close the issue with a comment directing the requester to support venues (Slack, Stack Overflow) and, if relevant, where to file an issue for bugs with features (kubernetes/kubernetes is a great place to start).
- example support request response
Sample response to a request for support:
```
Thank you for this report,
This sounds more like a request for support and less
This issue sounds more like a request for support and less
like an issue specifically for docs. I encourage you to bring
your question to the `#kubernetes-users` channel in
[Kubernetes slack](http://slack.k8s.io/). You can also search
@@ -82,11 +79,9 @@ You can also open issues for Kubernetes functionality in
If this is a documentation issue, please re-open this issue.
```
- example code bug report response
Sample code bug report response:
```
Thank you for this report,
This sounds more like an issue with the code than an issue with
the documentation. Please open an issue at
https://github.com/kubernetes/kubernetes/issues.