-
-
Notifications
You must be signed in to change notification settings - Fork 522
Documentation: fix broken WordPress VIP links in sniff docblocks #2637
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
b5c60bd to
52577bf
Compare
Update old https://vip.wordpress.com/documentation URLs to new https://docs.wpvip.com URLs in multiple sniff docblocks. The old links are redirecting to a generic page that doesn't provide any useful information about the related sniff. I was not able to find the corresponding new link for `EnqueuedResourcesSniff`, so I opted to remove the old link.
52577bf to
20b2c5a
Compare
|
cc @yolih |
jrfnl
left a comment
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.
✅ Verified old vs new links
@GaryJones Considering you are probably most familiar with the VIP documentation, would you be able to suggest an alternative link for the EnqueuedResources docblock link ?
Also: it might be a good idea to flag internally within A8C that these type of documentation reorganizations leave a lot of broken links around the web.... ?
|
@GaryJones 😁 We were clearly posting at the same time ;-) |
|
@GaryJones Hmm.. just noticed that the |
|
Comment fixed, so tagging @yolih now. |
|
@rodrigoprimo Thank you so much for taking the time to locate suitable URL replacements for these sniffs! My suggestion for a corresponding link for |
|
Thanks for the suggestion, @yolih! I don't think this is a good replacement as this link is about how VIPCS categorizes PHPCS errors/warnings by severity and not about the |
Description
Update old https://vip.wordpress.com/documentation URLs to new https://docs.wpvip.com URLs in multiple sniff docblocks. The old links are redirecting to a generic page that doesn't provide any useful information about the related sniff.
I was not able to find the corresponding new link for
EnqueuedResourcesSniff, so I opted to remove the old link. I'm not familiar with WordPress VIP docs so I might have missed the new location.It seems it is not the first time that WordPress VIP changed those URLs without configuring proper redirects (see #1499).
Suggested changelog entry
N/A