-
Notifications
You must be signed in to change notification settings - Fork 15.1k
Add page to explain issue review process #1860
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
adds a new page to the contribute section and navigation that describes the reviewing and labeling process for backlog/newly created issues
adding in left out section
|
Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). 📝 Please follow instructions at https://github.com/kubernetes/kubernetes/wiki/CLA-FAQ to sign the CLA. Once you've signed, please reply here (e.g. "I signed it!") and we'll verify. Thanks.
If you have questions or suggestions related to this bot's behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
|
docs/contribute/review-issues.md
Outdated
|
|
||
|
|
||
| #### 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) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you mean SWE, or is SME something different?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i meant subject matter expert
|
|
||
|
|
||
|
|
||
| {% capture whatsnext %} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If using the whatsnext section, all your other headings need to be at least H3 (###) or else the TOC gets confused. See the preview for example: https://deploy-preview-1860--kubernetes-io-vnext-staging.netlify.com/docs/contribute/review-issues/
|
I signed it! |
|
|
||
| {% capture overview %} | ||
|
|
||
| This page explains how you should review and prioritize documentation issues made for the [kubernetes/kubernetes.github.io](https://github.com/kubernetes/kubernetes.github.io){: target="_blank"} repository. The purpose is to provide a way to organize issues and make it easier to contribute to Kubernetes documentation. The following should be used as the standard way of prioritizing, labeling, and interacting with issues. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this render correctly?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i think so, i looks correct on netlify. is there something specific you were worried about, or the whole page?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think GH's raw markdown processor was a little wonky and italicized about half the document. If it looks fine in Netlify, LGTM.
|
@a-mccarthy We need to fix the merge conflict in the support TOC. |
adding a page and navigation link for the new issue review process to handle the backlog
This change is