[Docs] Add missing metadata in page “using-npm/semver” to fix broken links and nav #1572
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
|
I just committed a small change in one of the Tap tests — the one checking documentation for semver. Tests pass now. |
|
@isaacs, am I missing any step here for the team to be able to review the PR? |
ruyadorno
approved these changes
Aug 14, 2020
ruyadorno
added
Enhancement
|
Awesome finding! 🙌 Thank you so much for the fix @tripu! |
ruyadorno
pushed a commit
that referenced
this pull request
Aug 17, 2020
PR-URL: #1572 Credit: @tripu Close: #1572 Reviewed-by: @ruyadorno
ruyadorno
pushed a commit
that referenced
this pull request
Aug 17, 2020
PR-URL: #1572 Credit: @tripu Close: #1572 Reviewed-by: @ruyadorno
|
Excuse me, I'm not familiar with your workflow: when will this be deployed to This change does not show there yet, and I was wondering. |
This was referenced Mar 12, 2021
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Problem: there have been a number of broken links in
docs.npmjs.comfor quite some time now. At least hyperlinks to section Using npm / semver are broken.Examples: visit
docs.npmjs.com/configuring-npm/package-jsonand on your browser find the stringSee semver; there are 3 instances, all of them linking todocs.npmjs.com/using-npm/semver, which does not exist.A related outstanding issue (I believe) is that such subsection (semver) does not appear in the index page of section Using npm.
Solution: after digging a bit in the docs and how they are built, I think the cause may be that this specific page is lacking some metadata at the beginning. Because of that, the page is not generated, indexed and/or copied to the output dir. After changing this, Gatsby seems to be serving the page OK, and it appears in the nav sidebar element.