Skip to content
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

Templates for Issue creation #3964

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

Templates for Issue creation #3964

wants to merge 9 commits into from

Conversation

varodrig
Copy link
Contributor

@varodrig varodrig commented Jan 19, 2025

Relates to issue #3935
First PR templating issues with the website.
the implementation follows a similar approach as the kubernetes website: https://github.com/kubernetes/website/blob/main/.github/ISSUE_TEMPLATE/bug-report.md

added a support type following practices from the kubernetes website , the main idea is to guide end users on how to proceed when having issues. I created this since I saw some issues created that were asking for support.

Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign james-jwu for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@varodrig
Copy link
Contributor Author

varodrig commented Jan 19, 2025

@andreyvelich and @hbelmiro to review thank you and anyone else from the community who wants to provide feedback.
Also we need to create new labels before merging. Can you help with this?

" /area model-registry "
" /area notebooks "
" /area spark operator "
" /area trainer "
" /area other "

Created an issue
#3967

@varodrig varodrig mentioned this pull request Jan 19, 2025
@varodrig
Copy link
Contributor Author

/hold

Signed-off-by: varodrig <[email protected]>
@varodrig
Copy link
Contributor Author

cc @kubeflow/kubeflow-steering-committee @kubeflow/wg-training-leads @kubeflow/wg-pipeline-leads @kubeflow/wg-notebooks-leads @kubeflow/wg-manifests-leads @kubeflow/release-team @kubeflow/wg-data-leads @kubeflow/wg-deployment-leads

Copy link
Contributor

@hbelmiro hbelmiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@varodrig
Copy link
Contributor Author

/hold cancel

@varodrig
Copy link
Contributor Author

@hbelmiro @andreyvelich @thesuperzapper can you review?

Thanks.

@varodrig
Copy link
Contributor Author

/hold

@google-oss-prow google-oss-prow bot removed the lgtm label Jan 31, 2025
@varodrig
Copy link
Contributor Author

/hold cancel

Signed-off-by: varodrig <[email protected]>
.github/ISSUE_TEMPLATE/CHORE.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/BUG_REPORT.md Outdated Show resolved Hide resolved
Signed-off-by: varodrig <[email protected]>
Copy link
Contributor

@hbelmiro hbelmiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@google-oss-prow google-oss-prow bot added the lgtm label Feb 1, 2025
@varodrig
Copy link
Contributor Author

varodrig commented Feb 5, 2025

Since this is affecting all Working groups, please review

@hbelmiro @thesuperzapper @rimolive @tarilabs @franciscojavierarceo

Copy link
Member

@andreyvelich andreyvelich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@varodrig Would it be better to ask users to open website-related issues in the corresponding GitHub repositories for each project?

From our past experience, WG leads tend to triage issues more effectively in their own repos than in kubeflow/website.
cc @jbottum @rimolive

@varodrig
Copy link
Contributor Author

varodrig commented Feb 5, 2025

@varodrig Would it be better to ask users to open website-related issues in the corresponding GitHub repositories for each project?

From our past experience, WG leads tend to triage issues more effectively in their own repos than in kubeflow/website. cc @jbottum @rimolive

I think the issues should be created and maintain on the same repo the source code lives as software development practice. I think it'll be very confusing to move issues to other repo where the website doesn't belong. What will be the value to community on doing this? it seems to me that it'll add so much confusion. Do we have anyone in the CNCF ecosystem doing managing the website issues this way?

For the WG, they could easy triage the issues with the labels we have created in this same repo, where they can select their respective component. Maybe I'm missing what the problem is and what we are trying to solve?

Can we move this discussion to an issue as well if needed? it shouldn't block this PR since the PR is already using the labels already defined.

cc @thesuperzapper @hbelmiro @tarilabs @juliusvonkohout

Copy link
Member

@tarilabs tarilabs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @varodrig I think if we want to have templates for the GH Issues in the Website itself, I suppose it's fine as you are showing here.

My optional suggestion is to make it even more clear, in the body of the template, that this requests are intended to address the Website itself, more explicitly in addition to the title.

Example: make a checkbox at the top with text ~like "I acknowledge I am proposing changes to the website itself, and not for an individual component (which should be raised in the appropriate repo instead)"

For a example impacting MR WG, this issue #3969 is borderline between a doc change request for MR WG (which should be raised in the KF/model-registry repo) and a comment to the website itself -- OP created the issue here using the button on the website, despite we have this per KSC request:
Screenshot 2025-02-06 at 09 36 20

I believe @andreyvelich is cautioning about making clear that GH Issues raised here must be pertaining to the Website, not the individual WG, otherwise would be difficult to triage.

@andreyvelich
Copy link
Member

What will be the value to community on doing this? it seems to me that it'll add so much confusion. Do we have anyone in the CNCF ecosystem doing managing the website issues this way?

This just what worked for our community before. And from the Working Group point of view the development is going on in their repos, not in the kubeflow/website. Thus, it is easier for them to track all work in a single place:

  1. Design Proposal
  2. Implementation
  3. Tests
  4. Doc updates.

Maybe I'm missing what the problem is and what we are trying to solve?

As I said, we don't have anyone who will triage issues in kubeflow/website for now. If you can allocate your time to triage issues to the corresponding Working Group, we should be fine.

@varodrig
Copy link
Contributor Author

varodrig commented Feb 7, 2025

Thanks @varodrig I think if we want to have templates for the GH Issues in the Website itself, I suppose it's fine as you are showing here.

My optional suggestion is to make it even more clear, in the body of the template, that this requests are intended to address the Website itself, more explicitly in addition to the title.

Example: make a checkbox at the top with text ~like "I acknowledge I am proposing changes to the website itself, and not for an individual component (which should be raised in the appropriate repo instead)"

For a example impacting MR WG, this issue #3969 is borderline between a doc change request for MR WG (which should be raised in the KF/model-registry repo) and a comment to the website itself -- OP created the issue here using the button on the website, despite we have this per KSC request: Screenshot 2025-02-06 at 09 36 20

I believe @andreyvelich is cautioning about making clear that GH Issues raised here must be pertaining to the Website, not the individual WG, otherwise would be difficult to triage.

I think maybe we can clarify that if it's a proposal about a functionality itself should be on the component's repo.
I'll add something like:

"Have a proposal about a component's functionality or feedback on a feature? Submit an issue on any of the kubeflow components on their associated repository https://github.com/kubeflow."

We also have a new issue type which about support to help the community to find support by posting the problem on the right place.
@tarilabs let me know what you think

@varodrig
Copy link
Contributor Author

varodrig commented Feb 7, 2025

@andreyvelich @tarilabs @hbelmiro I'm moving this discussion to a new issue I created

#3988

Thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants