-
Notifications
You must be signed in to change notification settings - Fork 4.1k
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
Outdated handbook page for eslint-config package #14724
Comments
Interesting. https://wordpress.org/gutenberg/handbook/designers-developers/developers/packages/packages-eslint-plugin/ is the correct link. The recommended config, Of course you need to install the package first: The package was previously So the only issue I see here is that the https://wordpress.org/gutenberg/handbook/designers-developers/developers/packages/packages-eslint-config/ page should be deleted. |
Yeah, I believe I'd seen it come up once before in conversation that the current process for mirroring documentation from Gutenberg to WordPress.org does not account for deletion. It's a general issue affecting more than just this one page, though it may be a temporary fix to remove individual items. |
@dd32 or @tellyworth can you delete this page which no longer exists on GitHub? |
Done. |
Thanks! I guess we can close this issue now :-) |
I'd neglected to follow-up here, but I'd posed the question of deleting outdated documents during last week's #docs meeting (link requires registration): https://wordpress.slack.com/archives/C02RP4WU5/p1554134966087800 The general consensus seemed to be that it's difficult to justify putting resources toward fixing issues with the current solution, when there's an ongoing effort to migrate this documentation to DevHub as the canonical resource. If the issue comes up again, I suppose it'll need to similarly be handled in a one-off fashion, with Meta Trac as the designated issue tracker (?). |
@youknowriad, @aduth, @jasmussen, @ellatrix:
Describe the bug
On Gutenberg handbook page https://wordpress.org/gutenberg/handbook/designers-developers/developers/packages/packages-eslint-config/ the wrong package name
@wordpress/eslint-config
is specified.This package doesn't exist on npm, but the package
@wordpress/eslint-plugin
exists, which is from Gutenberg and describes itself as being the right one for extending eslint.Another issue is that this handbook page can't be edited/forked in GitHub,
the GitHub edit link leads to a 404 on GitHub.
To Reproduce
Steps to reproduce the behavior:
@wordpress/eslint-config
(npm
oryarn
).Notice that the package is not found and it is found on the npm registry neither (https://www.npmjs.com/search?q=%40wordpress%2Feslint-config).
Handbook page edit error:
Notice the 404 error on GitHub instead of the forked, editable page.
Expected behavior
Correct package name is stated, which should be
eslint-plugin
instead ofnon-existing
@wordpress/eslint-config
, not only in the example install command butalso everywhere else (like where eslint is extended with it).
Edit: Extending eslint with the other package
@wordpress/eslint-plugin
using the config from the package readme (plugin:@wordpress/eslint-plugin/recommended
) results in an error, too:Error: Failed to load plugin @wordpress: Cannot find module 'eslint-plugin-@wordpress'
.There is another handbook page that uses the other package name, but the example config fails:
https://wordpress.org/gutenberg/handbook/designers-developers/developers/packages/packages-eslint-plugin/
The text was updated successfully, but these errors were encountered: