created issue-wrangler.md #42273
created issue-wrangler.md #42273
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
language/en
|
Welcome @haripriya9647! |
k8s-ci-robot
added
the
size/M
|
Hello @divya-mohan0209 I have created a sample draft. Please let me know what improvements and expectations needs to be fulfilled |
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
I've left a couple of changes. However, I'd like this to be more in alignment with the sections that the PR Wrangler file has. For example, Helpful GitHub queries, Helpful PROW commands, and when to close the issue would be better placed instead of the process implementation and the contributor hierarchy section.
|
|
||
| <!-- overview --> | ||
|
|
||
| There are many issues that need triage, and in order to reduce our reliance on formal approvers or reviewers, we have introduced a new role to wrangle issues every week.The main responsibility of this role is to bridge the gap between organizational contributor and reviewer. |
There was a problem hiding this comment.
I'd recommend this to be phrased as below
| There are many issues that need triage, and in order to reduce our reliance on formal approvers or reviewers, we have introduced a new role to wrangle issues every week.The main responsibility of this role is to bridge the gap between organizational contributor and reviewer. | |
| In order to reduce the burden on the [PR Wrangler](/docs/contribute/participate/pr-wrangler), formal approvers, and reviewers, members of SIG Docs take week long shifts [triaging and categorising issues](/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues) for the repository. | |
| This section covers the duties of an Issue Wrangler. |
| <!-- overview --> | ||
|
|
||
| There are many issues that need triage, and in order to reduce our reliance on formal approvers or reviewers, we have introduced a new role to wrangle issues every week.The main responsibility of this role is to bridge the gap between organizational contributor and reviewer. | ||
| This section covers the duties of a PR wrangler. |
There was a problem hiding this comment.
| This section covers the duties of a PR wrangler. |
|
|
||
| Each day in a week-long shift as Issue Wrangler: | ||
|
|
||
| - Making sure the issue is worded and titled correctly to provide contributors with adequate information. |
There was a problem hiding this comment.
| - Making sure the issue is worded and titled correctly to provide contributors with adequate information. | |
| - Triage and tag incoming issues daily. See [Triage and categorize issues](https://github.com/kubernetes/website/blob/main/docs/contribute/review/for-approvers/#triage-and-categorize-issues) for guidelines on how SIG Docs uses metadata. |
There was a problem hiding this comment.
As an aside, we might want to remove this from the PR Wrangler file to avoid overlap. Thoughts?
There was a problem hiding this comment.
Totally agree!!
|
@divya-mohan0209 please have a look at these commits and suggest me improvements. I need some help regarding the GitHub queries. If you can assist me in what queries needs to be listed I will try elaborating based on your suggestions. Apart from this please let me know if you wish me to add the [note] in the issue wrangler page as well. |
|
|
||
| <!-- overview --> | ||
|
|
||
| In order to reduce the burden on the [PR Wrangler](/docs/contribute/participate/pr-wrangler), formal approvers, and reviewers, members of SIG Docs take week long shifts [triaging and categorising issues](/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues) for the repository. |
There was a problem hiding this comment.
It appears that the link may require updating.
| In order to reduce the burden on the [PR Wrangler](/docs/contribute/participate/pr-wrangler), formal approvers, and reviewers, members of SIG Docs take week long shifts [triaging and categorising issues](/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues) for the repository. | |
| In order to reduce the burden on the [PR Wrangler](/docs/contribute/participate/pr-wranglers), formal approvers, and reviewers, members of SIG Docs take week long shifts [triaging and categorising issues](/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues) for the repository. |
There was a problem hiding this comment.
I would rephrase it as below for more clarity
| In order to reduce the burden on the [PR Wrangler](/docs/contribute/participate/pr-wrangler), formal approvers, and reviewers, members of SIG Docs take week long shifts [triaging and categorising issues](/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues) for the repository. | |
| In order to reduce the burden on the [PR Wrangler](/docs/contribute/participate/pr-wrangler) and formal approvers, and reviewers, members of SIG Docs take week long shifts [triaging and categorising issues](/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues) for the repository. |
|
|
||
| Each day in a week-long shift as Issue Wrangler: | ||
|
|
||
| - Triage and tag incoming issues daily. See [Triage and categorize issues](https://github.com/kubernetes/website/blob/main/docs/contribute/review/for-approvers/#triage-and-categorize-issues) for guidelines on how SIG Docs uses metadata. |
There was a problem hiding this comment.
The github link appears to be directing to a 404 error page; an update might be needed.
(There is also option to use /docs/contribute/review/for-approvers/#triage-and-categorize-issues)
| - Triage and tag incoming issues daily. See [Triage and categorize issues](https://github.com/kubernetes/website/blob/main/docs/contribute/review/for-approvers/#triage-and-categorize-issues) for guidelines on how SIG Docs uses metadata. | |
| - Triage and tag incoming issues daily. See [Triage and categorize issues](https://github.com/kubernetes/website/blob/main/content/en/docs/contribute/review/for-approvers.md#triage-and-categorize-issues) for guidelines on how SIG Docs uses metadata. |
|
Thanks @dipesh-rawat .I will add commit |
|
|
||
| <!-- overview --> | ||
|
|
||
| In order to reduce the burden on the [PR Wrangler](/docs/contribute/participate/pr-wrangler), formal approvers, and reviewers, members of SIG Docs take week long shifts [triaging and categorising issues](/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues) for the repository. |
There was a problem hiding this comment.
I would rephrase it as below for more clarity
| In order to reduce the burden on the [PR Wrangler](/docs/contribute/participate/pr-wrangler), formal approvers, and reviewers, members of SIG Docs take week long shifts [triaging and categorising issues](/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues) for the repository. | |
| In order to reduce the burden on the [PR Wrangler](/docs/contribute/participate/pr-wrangler) and formal approvers, and reviewers, members of SIG Docs take week long shifts [triaging and categorising issues](/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues) for the repository. |
| However, encourage the user to provide more details or reopen the issue if they can reproduce it later. | ||
| - Having implemented the same functionality elsewhere. One can close this issue and direct user to the appropriate place. | ||
| - Feature requests that are not currently planned or aligned with the project's goals. | ||
| - If the assignee has not responded to comments or feedback in more than two weeks |
There was a problem hiding this comment.
This is a very arbitrary & sketchy timeline.
@sftim @natalisucks @reylejano : Any thoughts on this?
There was a problem hiding this comment.
I would leave out a time frame to respond back
Anyone can assign themselves an issue. I don't think it's appropriate to close an issue if an assignee does not reply to comments or take action.
There was a problem hiding this comment.
@divya-mohan0209 I am thinking of removing line 53. Is that okay or should I mention something else replacing this ??
There was a problem hiding this comment.
@haripriya9647 : Please remove line 53.
|
@divya-mohan0209 waiting for your suggestions on this |
|
@haripriya9647 : Thank you for bearing with the delay in my response. Please proceed with removal of line 53. |
|
@divya-mohan0209 I have already removed line 53 in the latest commit. It seems like this pr is ready :) |
| - A minimum of 15 [non-trivial](https://www.kubernetes.dev/docs/guide/pull-requests/#trivial-edits) contributions to Kubernetes (of which a certain amount should be directed towards kubernetes/website). | ||
| - Performing the role in an informal capacity already | ||
|
|
||
| ### Helpful [Prow commands](https://prow.k8s.io/command-help) for wranglers |
There was a problem hiding this comment.
Extra: mention /close not-planned (useful when closing an issue we won't work on and haven't fixed - for example, a duplicate bug report)
|
|
||
| <!-- overview --> | ||
|
|
||
| In order to reduce the burden on the [PR Wrangler](/docs/contribute/participate/pr-wranglers),and formal approvers, and reviewers, members of SIG Docs take week long shifts [triaging and categorising issues](/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues) for the repository. |
There was a problem hiding this comment.
| In order to reduce the burden on the [PR Wrangler](/docs/contribute/participate/pr-wranglers),and formal approvers, and reviewers, members of SIG Docs take week long shifts [triaging and categorising issues](/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues) for the repository. | |
| Alongside the [PR Wrangler](/docs/contribute/participate/pr-wranglers),and formal approvers, and reviewers, members of SIG Docs take week long shifts [triaging and categorising issues](/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues) for the repository. |
|
@sftim I have added commits as suggested. Please have a look |
There was a problem hiding this comment.
/triage duplicate: When the issue is found to be a duplicate or subset of an existing open issue. It's also used oftenly before marking an issue for/close not-plannedbecause of its duplication./triage needs-information: When information provided by author is not sufficient to address the issue. It's also used before marking an issue for/close not-planneddue to not sufficient information available./priority backlog: For marking an issue with higher priority than normal issues due to some bug or backlog.
These labels are used oftenly, and so i thought of suggesting them to add here too. What do you think?
There was a problem hiding this comment.
Left some final feedback. Overall LGTM. Once this feedback is addressed, we can proceed for merging the PR.
Thank you @haripriya9647 for taking this up!
|
|
||
| ## Duties | ||
|
|
||
| Each day in a week-long shift as Issue Wrangler: |
There was a problem hiding this comment.
nit
| Each day in a week-long shift as Issue Wrangler: | |
| Each day in a week-long shift, the Issue Wrangler will be responsible for: |
| Each day in a week-long shift as Issue Wrangler: | ||
|
|
||
| - Triage and tag incoming issues daily. See [Triage and categorize issues](https://github.com/kubernetes/website/blob/main/content/en/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues) for guidelines on how SIG Docs uses metadata. | ||
| - Identifying whether the issue falls under the support category and assigning a "triage/accepted" status. |
There was a problem hiding this comment.
| - Identifying whether the issue falls under the support category and assigning a "triage/accepted" status. |
|
|
||
| - Triage and tag incoming issues daily. See [Triage and categorize issues](https://github.com/kubernetes/website/blob/main/content/en/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues) for guidelines on how SIG Docs uses metadata. | ||
| - Identifying whether the issue falls under the support category and assigning a "triage/accepted" status. | ||
| - Ensuring the issue is tagged with the appropriate sig/area/kind labels. |
There was a problem hiding this comment.
| - Ensuring the issue is tagged with the appropriate sig/area/kind labels. |
| - Triage and tag incoming issues daily. See [Triage and categorize issues](https://github.com/kubernetes/website/blob/main/content/en/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues) for guidelines on how SIG Docs uses metadata. | ||
| - Identifying whether the issue falls under the support category and assigning a "triage/accepted" status. | ||
| - Ensuring the issue is tagged with the appropriate sig/area/kind labels. | ||
| - Keeping an eye on stale & rotten issues within the kubernetes/website repository. |
There was a problem hiding this comment.
| - Keeping an eye on stale & rotten issues within the kubernetes/website repository. | |
| - Keeping an eye on stale & rotten issues within the kubernetes/website repository. |
|
|
||
| Each day in a week-long shift as Issue Wrangler: | ||
|
|
||
| - Triage and tag incoming issues daily. See [Triage and categorize issues](https://github.com/kubernetes/website/blob/main/content/en/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues) for guidelines on how SIG Docs uses metadata. |
There was a problem hiding this comment.
| - Triage and tag incoming issues daily. See [Triage and categorize issues](https://github.com/kubernetes/website/blob/main/content/en/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues) for guidelines on how SIG Docs uses metadata. | |
| - Triaging and tagging incoming issues daily. See [Triage and categorize issues](https://github.com/kubernetes/website/blob/main/content/en/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues) for guidelines on how SIG Docs uses metadata. |
| - Identifying whether the issue falls under the support category and assigning a "triage/accepted" status. | ||
| - Ensuring the issue is tagged with the appropriate sig/area/kind labels. | ||
| - Keeping an eye on stale & rotten issues within the kubernetes/website repository. | ||
| - Maintenance of [Issues board](https://github.com/orgs/kubernetes/projects/72/views/1) would be nice |
There was a problem hiding this comment.
| - Maintenance of [Issues board](https://github.com/orgs/kubernetes/projects/72/views/1) would be nice | |
| Maintenance of the [Issues board](https://github.com/orgs/kubernetes/projects/72/views/1). |
|
|
||
| Close issues when: | ||
|
|
||
| - When a similar issue is reported more than once, you'll first tag it as /triage duplicate; link it to the main issue & then close it. It is also advisable to direct the users to the original issue. |
There was a problem hiding this comment.
| - When a similar issue is reported more than once, you'll first tag it as /triage duplicate; link it to the main issue & then close it. It is also advisable to direct the users to the original issue. | |
| - A similar issue is reported more than once. You will first need to tag it as /triage duplicate; link it to the main issue & then close it. It is also advisable to direct the users to the original issue. |
| - When a similar issue is reported more than once, you'll first tag it as /triage duplicate; link it to the main issue & then close it. It is also advisable to direct the users to the original issue. | ||
| - It is very difficult to understand and address the issue presented by the author with the information provided. | ||
| However, encourage the user to provide more details or reopen the issue if they can reproduce it later. | ||
| - Having implemented the same functionality elsewhere. One can close this issue and direct user to the appropriate place. |
There was a problem hiding this comment.
| - Having implemented the same functionality elsewhere. One can close this issue and direct user to the appropriate place. | |
| - The same functionality is implemented elsewhere. One can close this issue and direct user to the appropriate place. |
| - It is very difficult to understand and address the issue presented by the author with the information provided. | ||
| However, encourage the user to provide more details or reopen the issue if they can reproduce it later. | ||
| - Having implemented the same functionality elsewhere. One can close this issue and direct user to the appropriate place. | ||
| - Feature requests that are not currently planned or aligned with the project's goals. |
There was a problem hiding this comment.
| - Feature requests that are not currently planned or aligned with the project's goals. | |
| - The reported issue is not currently planned or aligned with the project's goals. |
| However, encourage the user to provide more details or reopen the issue if they can reproduce it later. | ||
| - Having implemented the same functionality elsewhere. One can close this issue and direct user to the appropriate place. | ||
| - Feature requests that are not currently planned or aligned with the project's goals. | ||
| - In cases where an issue appears to be spam and is clearly unrelated. |
There was a problem hiding this comment.
| - In cases where an issue appears to be spam and is clearly unrelated. | |
| - If the issue appears to be spam and is clearly unrelated. |
|
Related to #41601 (Just for adding a link to the issue) |
|
|
||
| <!-- overview --> | ||
|
|
||
| Alongside the [PR Wrangler](/docs/contribute/participate/pr-wranglers),and formal approvers, and reviewers, members of SIG Docs take week long shifts [triaging and categorising issues](/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues) for the repository. |
There was a problem hiding this comment.
| Alongside the [PR Wrangler](/docs/contribute/participate/pr-wranglers),and formal approvers, and reviewers, members of SIG Docs take week long shifts [triaging and categorising issues](/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues) for the repository. | |
| Alongside the [PR Wrangler](/docs/contribute/participate/pr-wranglers), formal approvers, reviewers, and members of SIG Docs take week long shifts [triaging and categorising issues](/docs/contribute/review/for-approvers.md/#triage-and-categorize-issues) for the repository. |
|
@haripriya9647 Mind give this another stab? |
|
@divya-mohan0209 I have added all the commits as suggested. Please have a look. |
|
Thank you @haripriya9647 for these changes and for your patience! |
k8s-ci-robot
added
the
lgtm
|
LGTM label has been added. Git tree hash: b85a3802c6f22a669257a99f3b99be3cf67c8676
|
|
Great work @haripriya9647 and a big thank you to everyone who has contributed reviews. Lets get this live so we can start issue wrangling! 🚀 ✨ |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: natalisucks The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
Added issue wrangler.md file