FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: fix broken links in modules.md by Trott · Pull Request #35182 · nodejs/node · GitHub

/ node Public

doc: fix broken links in modules.md - #35182

Merged
Trott merged 1 commit into
nodejs:masterfrom
Trott:moved
Sep 14, 2020
ConversationCommits (1)ChecksFiles changed
Merged

doc: fix broken links in modules.md#35182
Trott merged 1 commit into
nodejs:masterfrom
Trott:moved

Conversation

Trott commented Sep 14, 2020

Copy link
Copy Markdown
Member
Checklist

nodejs-github-bot commented Sep 14, 2020

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/modules

nodejs-github-bot added doc Issues and PRs related to the documentations. module Issues and PRs related to the module subsystem. labels Sep 14, 2020
GeoffreyBooth added the fast-track PRs that do not need to wait for 48 hours to land. label Sep 14, 2020
DerekNonGeneric approved these changes Sep 14, 2020
View reviewed changes

DerekNonGeneric left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

This probably should have been caught by tools/doc/checkLinks.js. I haven't looked into it yet, but perhaps it's broken? There are literally pages of PRs fixing broken links (some of which are very recent). 😕

lpinca commented Sep 14, 2020 •
edited
Loading

Copy link
Copy Markdown
Member

This probably should have been caught by tools/doc/checkLinks.js

I think it skips api dirs.

richardlau commented Sep 14, 2020

Copy link
Copy Markdown
Member

This probably should have been caught by tools/doc/checkLinks.js. I haven't looked into it yet, but perhaps it's broken? There are literally pages of PRs fixing broken links (some of which are very recent). 😕

I haven't dug into why but it looks like the api docs are deliberately excluded:

node/tools/doc/checkLinks.js

Line 29 in 9d12c14

entry.name !== 'api' &&

aduh95 commented Sep 14, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor

This should be tested when building the HTML, but apparently it only tests links internal to all.html page:

node/tools/doc/allhtml.js

Lines 85 to 88 in 9d12c14

const hrefRe = / href="#(\w+)"/g;
while (match = hrefRe.exec(all)) {
if (!ids.has(match[1])) throw new Error(`link not found: ${match[1]}`);
}

Usually that would cover all links internal to the docs, as all links to doc pages are stripped from the filename to keep only the hash part:

node/tools/doc/allhtml.js

Lines 39 to 45 in 9d12c14

apicontent += data.slice(match.index + match[0].length)
.replace(/<!-- API END -->[\s\S]*/, '')
.replace(/<a href="(\w[^#"]*)#/g, (match, href) => {
return htmlFiles.includes(href) ? '<a href="#' : match;
})
.trim() + '\n';

But in this case, because modules_module.html doesn't exist, it's treated as an external page and the broken links slip through the test…

I haven't dug into why but it looks like the api docs are deliberately excluded

Yes indeed. The reason checkLinks.js does not cover api is because we are using .html extension to reference other doc pages, while checkLinks.js would expect .md. One way of fixing it would be to use .md extensions in the Markdown files, and use checkLinks.js to test said links – it would also improve the experience of navigating the docs through GitHub web UI. Another way would be to tweak the current test to make sure this doesn't reproduce.

DerekNonGeneric commented Sep 14, 2020

Copy link
Copy Markdown
Contributor

Thanks for looking into this @aduh95; I've opened a separate issue @ #35189 so as not to derail.

Seeing as how others have already taken interest in tackling it themselves (see #35186), this should probably be fast-tracked.

Please 👍 this comment to approve fast-tracking

aduh95 mentioned this pull request Sep 14, 2020
Merged
4 tasks
Trott merged commit fb1ab19 into nodejs:master Sep 14, 2020

Trott commented Sep 14, 2020

Copy link
Copy Markdown
Member Author

Landed in fb1ab19

Trott deleted the moved branch September 14, 2020 19:40
doc: fix broken links in modules.md
fb1ab19 
PR-URL: nodejs#35182
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Zeyu Yang <himself65@outlook.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
ruyadorno pushed a commit that referenced this pull request Sep 17, 2020
doc: fix broken links in modules.md
176e9e4 
PR-URL: #35182
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Zeyu Yang <himself65@outlook.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
ruyadorno mentioned this pull request Sep 21, 2020
Merged
4 tasks
MylesBorins pushed a commit that referenced this pull request Nov 3, 2020
doc: fix broken links in modules.md
a573e0b 
PR-URL: #35182
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Zeyu Yang <himself65@outlook.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
MylesBorins mentioned this pull request Nov 3, 2020
Merged
MylesBorins pushed a commit that referenced this pull request Nov 4, 2020
doc: fix broken links in modules.md
d12a6f3 
PR-URL: #35182
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Zeyu Yang <himself65@outlook.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
MylesBorins pushed a commit that referenced this pull request Nov 16, 2020
doc: fix broken links in modules.md
79f3c32 
PR-URL: #35182
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Zeyu Yang <himself65@outlook.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
joesepi pushed a commit to joesepi/node that referenced this pull request Jan 8, 2021
doc: fix broken links in modules.md
4ab9cbb 
PR-URL: nodejs#35182
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Zeyu Yang <himself65@outlook.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
This file contains hidden or 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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

GeoffreyBooth GeoffreyBooth approved these changes
guybedford guybedford approved these changes
lpinca lpinca approved these changes
himself65 himself65 approved these changes
+2 more reviewers
DerekNonGeneric DerekNonGeneric approved these changes
crypt096 crypt096 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

doc Issues and PRs related to the documentations. fast-track PRs that do not need to wait for 48 hours to land. module Issues and PRs related to the module subsystem.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

10 participants

Back | FazBrowse Home | New Git URL