While reading the contributors handbook I found a few "broken" GitHub links
eruizdechavez opened this issue · 2 comments
Bug Report
- Yes, I reviewed the contribution guidelines.
- Yes, more specifically, I reviewed the guidelines on how to write clear bug reports.
Describe the current, buggy behavior
While reading the contributors handbook I found a few "broken" GitHub links.
Clicking on all "documentation issues", "search issues", etc. links on the Handbook took me to a GitHub 404 page. I initially thought it was a malformed link so I forked the handbook repo and proceeded to find and update all these links. Before committing my change, I decided to test both, the "broken" and fixed links and found that all previously "broken" links were no longer broken.
Turns out GitHub does not allow logged out users to perform issue searches directly on /issues
.
Describe how other contributors can replicate this bug
- Open a browser where you do not have an open GitHub session and go to https://github.com/issues?utf8=%E2%9C%93&q=sort%3Aupdated-desc+org%3Awp-cli+label%3Abug.
- GitHub shows a 404 error page.
Describe what you would expect as the correct outcome
All the links referencing a list of GitHub issues should take the user to said list of issues, no matter if the user is currently logged in to GitHub or not.
Let us know what environment you are running this on
Some examples at https://make.wordpress.org/cli/handbook/contributions/contributing/.
Provide a possible solution
Since the lists of issues are showing issues distributed across several repositories, the only solution I can think of so far is to use a search URL. Here is an example:
Broken for logged out users: https://github.com/issues?utf8=%E2%9C%93&q=sort%3Aupdated-desc+org%3Awp-cli+label%3Abug
Works for logged out users: https://github.com/search?q=label%3Abug+org%3Awp-cli+is%3Aopen&type=issues
Another option would be to do something similar to what is done in the good-first-issues link which is (as far as I can tell) not part of this documentation.
Provide additional context/Screenshots
That's It!
I am happy to send a pull request with such changes if the described possible solution is acceptable.
Thanks for the suggestion, @eruizdechavez !
I wasn't aware of https://github.com/search
, and that it works for logged out users. It'd be great to swap out the links 😊
@danielbachhuber I know right! The advanced search endpoint is not that obvious, just visible on a teeny-tiny link on some search results.
Anyway, I just submitted a pull request with the link updates; let me know if that works or if I need to do some other updates.