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.

Sign up for GitHub

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

Jump to bottom

[docs-infra] Adjust the links to search for issues #11995

Merged
merged 5 commits into from
Apr 4, 2024
Merged

[docs-infra] Adjust the links to search for issues #11995

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
990b4ab
adjusted the link to search for issues
michelengelen Feb 8, 2024
a4b956c
aligned link with support page
michelengelen Feb 8, 2024
567703d
removed utf8 param from link
michelengelen Feb 21, 2024
d31ab09
Merge remote-tracking branch 'upstream/master' into issues/adjusted-l…
michelengelen Apr 4, 2024
e738f41
fixed issue list link
michelengelen Apr 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/1.bug.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ body:
attributes:
label: Search keywords
description: |
Your issue may have already been reported! First search for duplicates among the [existing issues](https://github.com/mui/mui-x/issues).
Your issue may have already been reported! First search for duplicates among the [existing issues](https://github.com/mui/mui-x/issues?q=is%3Aopen+is%3Aclosed).
Copy link
Member

Choose a reason for hiding this comment

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

I think that we are missing the extra is:issue argument in all of these instances.
By going to /issues both is:issue and is:open filters are applied.

Copy link
Member Author

Choose a reason for hiding this comment

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

This is a bit of a generalistic question.

  1. PRs on github are also issues and is:issue would exclude them: Do we want to include PRs in this search or not? 🤷🏼
  2. is:open will not show any closed issues, but since the issue might be already asked/solved we absolutely want to have them in this list.

Copy link
Member

Choose a reason for hiding this comment

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

But PRs generally target resolving an issue.
I'm not sure we should be polluting the list of searchable entries by including PRs. 🤷
I just raised the point, that this technically causes a "regression" as compared to the existing approach.
If we actually want to include PRs as well, then sure, all is good, but I didn't see anything mentioned about this in the description, hence the flagging. 😉

Copy link
Member Author

Choose a reason for hiding this comment

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

I have no strong opinion on incuding PRs or not ... Most of the time the search should be accompanied by a search term to limit the results anyways, so the PRs might not be as prominent.

On the other hand you are right about the purpose of PRs in general. There might be additional information in them that could sometimes lead the user to a solution they are looking for, but there are too many ifs and buts in this.

I will add the is:issue parameter

Copy link
Member Author

Choose a reason for hiding this comment

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

Or rather: I will change this to https://github.com/mui/mui-x/issues?q=is%3Aissue

This will naturally include all issue states! 👍🏼

Copy link
Member

Choose a reason for hiding this comment

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

Nice, that seems to be the most correct. 👍
I double-checked, that adding both is:open and is:closed filters seems to work incorrectly. 🙈
The only way to achieve identical results is by applying the following filter:

is:issue is:open|is:closed

If your issue isn't a duplicate, great! Please list the keywords you used so people in the future can find this one more easily:
validations:
required: true
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/2.feature.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ body:
attributes:
label: Search keywords
description: |
Your issue may have already been reported! First search for duplicates among the [existing issues](https://github.com/mui/mui-x/issues).
Your issue may have already been reported! First search for duplicates among the [existing issues](https://github.com/mui/mui-x/issues?q=is%3Aopen+is%3Aclosed).
If your issue isn't a duplicate, great! Please list the keywords you used so people in the future can find this one more easily:
validations:
required: true
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/3.pro-support.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ body:
attributes:
label: Search keywords
description: |
Your issue may have already been reported! First search for duplicates among the [existing issues](https://github.com/mui/mui-x/issues).
Your issue may have already been reported! First search for duplicates among the [existing issues](https://github.com/mui/mui-x/issues?q=is%3Aopen+is%3Aclosed).
If your issue isn't a duplicate, great! Please list the keywords you used so people in the future can find this one more easily:
validations:
required: true
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/4.premium-support.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ body:
attributes:
label: Search keywords
description: |
Your issue may have already been reported! First search for duplicates among the [existing issues](https://github.com/mui/mui-x/issues).
Your issue may have already been reported! First search for duplicates among the [existing issues](https://github.com/mui/mui-x/issues?q=is%3Aopen+is%3Aclosed).
If your issue isn't a duplicate, great! Please list the keywords you used so people in the future can find this one more easily:
validations:
required: true
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/5.priority-support.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ body:
attributes:
label: Search keywords
description: |
Your issue may have already been reported! First search for duplicates among the [existing issues](https://github.com/mui/mui-x/issues).
Your issue may have already been reported! First search for duplicates among the [existing issues](https://github.com/mui/mui-x/issues?q=is%3Aopen+is%3Aclosed).
If your issue isn't a duplicate, great! Please list the keywords you used so people in the future can find this one more easily:
validations:
required: true
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/6.docs-feedback.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ body:
attributes:
label: Search keywords
description: |
Your issue may have already been reported! First search for duplicates among the [existing issues](https://github.com/mui/mui-x/issues).
Your issue may have already been reported! First search for duplicates among the [existing issues](https://github.com/mui/mui-x/issues?q=is%3Aopen+is%3Aclosed).
If your issue isn't a duplicate, great! Please list the keywords you used so people in the future can find this one more easily:
validations:
required: true
Expand Down
2 changes: 1 addition & 1 deletion docs/data/introduction/support/support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ We use GitHub issues as a bug and feature request tracker.

If you think you've found a bug, or you have a new feature idea:

1. Please start by [making sure it hasn't already been reported or fixed](https://github.com/mui/mui-x/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aclosed).
1. Please start by [making sure it hasn't already been reported or fixed](https://github.com/mui/mui-x/issues?q=is%3Aopen+is%3Aclosed).
You can search through existing issues and pull requests to see if someone has reported one similar to yours.
2. Then, if no duplicates exist, [open an issue](https://github.com/mui/mui-x/issues/new/choose) in the MUI X repository.

Expand Down