Fix relative links in main package READMEs so that they work in npm #38609
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
talldan
requested review from
gziolo,
mkaz,
nerrad,
ntwb and
ryanwelcher
as code owners
talldan
commented
Feb 8, 2022
| @@ -1,6 +1,6 @@ | |||
| # Block Serialization Default Parser | |||
|
|
|||
| This library contains the default block serialization parser implementations for WordPress documents. It provides native PHP and JavaScript parsers that implement the [specification](/docs/contributors/grammar.md) from [`@wordpress/block-serialization-spec-parser`](https://github.com/WordPress/gutenberg/tree/HEAD/packages/block-serialization-spec-parser/README.md) and which normally operates on the document stored in `post_content`. | |||
| This library contains the default block serialization parser implementations for WordPress documents. It provides native PHP and JavaScript parsers that implement the [specification](https://github.com/WordPress/gutenberg/tree/HEAD/docs/contributors/grammar.md) from [`@wordpress/block-serialization-spec-parser`](https://github.com/WordPress/gutenberg/tree/HEAD/packages/block-serialization-spec-parser/README.md) and which normally operates on the document stored in `post_content`. | |||
There was a problem hiding this comment.
Hmm, this seems to have been a broken link anyway. I'll try to fix it.
talldan
commented
Feb 8, 2022
talldan
commented
Feb 8, 2022
gziolo
approved these changes
Feb 8, 2022
|
Thanks for the quick review!
Hmm, that's a good point and not ideal. I guess we might be able to rewrite these links when publishing to the handbook, but I'm not sure where that change would be made. |
Yes, it might be possible if always use the same URL. It is now standardized to https://github.com/WordPress/gutenberg/tree/HEAD/ so we can update the regular expression that is used to replace URLs with internal links. I only forgot which repository is used to sync the docs with the dev portal. I'll try to find it. |
|
I think I've found the importer: It should be as simple as ensuring that the regular expressions cover also the case with URLs. Maybe they do already? 😅 |
|
Size Change: +36 B (0%) Total Size: 1.14 MB
ℹ️ View Unchanged
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Follow up to #38605.
In that PR, I discovered when npm displays the README for the package, it interprets relative links incorrectly resulting in a broken URL. This is probably an npm bug, but I haven't figured out where to report it yet (one of these - https://github.com/orgs/npm/repositories?type=all).
This PR updates some of the relative links I found using find/replace, changing them to absolute links.
Testing Instructions
To reproduce the bug, try the links in the first paragraph of the core-data package in npm - https://www.npmjs.com/package/@wordpress/core-data.
You can see they're broken but they work ok in github - https://github.com/WordPress/gutenberg/tree/trunk/packages/core-data
If you try an absolute link in npm, like the one in the second 'Installation' section for core-data, that seems to work fine - https://www.npmjs.com/package/@wordpress/core-data.
So it seems like changing to absolute URLs is the best thing to do right now.
Types of changes
Docs