Docs: Remove and update VIP link references #1499
Conversation
jrfnl
left a comment
jrfnl
left a comment
There was a problem hiding this comment.
Hi Gary, I've had a look.
Regarding the link updates 👍
Regarding the link removals in the VIP ruleset and deprecated VIP sniffs: I think those shouldn't be removed at this time.
Both the VIP ruleset as well as the deprecated VIP sniffs will be removed in WPCS 2.0.0 which - per previous discussions on the topic - should be released before the end of the year.
Removing the links now feels redundant and confusing.
I'd disagree (obviously, because otherwise I wouldn't have removed them!). VIPCS contains two standards, one for each platform. Those platforms have different requirements, and there are two different pages of documentation for them. Some of the links I removed were just outright broken (404), and it wasn't clear whether the rules from the WordPress-VIP standard were for WPCOM, or VIP-Go, or both. I'd rather remove all contextual/inline link references, and just point potential users to the two authoritative pages that matter. The ruleset that's left should be confusing - we want to encourage people not to use it.
Maybe we don't end up having another 1.x release before a 2.0 release (unlikely, but possible), and the ruleset and sniffs get remove completely - that's fine, but at least in the meantime, the If there is another 1.x release, then at least we're removing a little bit more support, without breaking BC at the code level, before intentionally breaking BC. |
jrfnl
left a comment
jrfnl
left a comment
There was a problem hiding this comment.
and just point potential users to the two authoritative pages that matter.
Ok, so you are doing this in the ruleset and I can accept that.
However, for the deprecated sniffs, this is not done, while IMO, it should be.
GaryJones
force-pushed
the
feature/vip-link-references
branch
from
37dde49 to
97c64cf
Compare
|
I've added in VIP-Go references to the Sniff classes, where one exists, or WPCOM (lobby) post if it doesn't seem to matter on VIP-Go. |
GaryJones
force-pushed
the
feature/vip-link-references
branch
2 times, most recently
from
ad0d93a to
7eb75d9
Compare
jrfnl
left a comment
jrfnl
left a comment
There was a problem hiding this comment.
The PR will probably need to be rebased for the build to pass, but other than that, good to go.
The WordPress.com VIP team moved their coding standards documentation around, since they now have different documents for their different platforms: - [WPCOM platform](https://lobby.vip.wordpress.com/wordpress-com-documentation/code-review-what-we-look-for/) (only available to those with VIP Lobby access) - [VIP-Go platform](https://vip.wordpress.com/documentation/vip-go/code-review-blockers-warnings-notices/) Many of the existing link references were out of date and pointed to pages or page anchors that didn't exist. Since our `WordPress-VIP` standard is deprecated, and will be removed in `2.0.0`, it's easier to remove all of the link references in the `VIP` category ruleset and sniffs. The only ones that remain are ones that are used as references for sniffs typically found in `WordPress-Extra` (outside of the `VIP` category). They have been updated as necessary.
GaryJones
force-pushed
the
feature/vip-link-references
branch
from
7eb75d9 to
48ea0e3
Compare
|
Rebased. |
The WordPress.com VIP team moved their coding standards documentation around, since they now have different documents for their different platforms:
Many of the existing link references were out of date and pointed to pages or page anchors that didn't exist. Since our
WordPress-VIPstandard is deprecated, and will be removed in2.0.0, it's easier to remove all of the link references in theVIPcategory ruleset and sniffs. I've added links to the above two pages into the ruleset.The only references that remain are ones that are used as references for sniffs typically found in
WordPress-Extra(outside of theVIPcategory). They have been updated as necessary.