doc: Broken (404ing) links in Docs #26074

Activity

1. ofrobots

   added

   docIssues and PRs related to Node.js documentation.Issues and PRs related to Node.js documentation.

   on Feb 14, 2019
2. gengjiawen commented on Feb 14, 2019

   

   gengjiawen

   on Feb 14, 2019

   Member

   More actions

   http://man7.org/linux/man-pages/man1/curl.1.html this link is in this page https://nodejs.org/api/repl.html, The link is not in the repl.md, maybe we have a bug in generating the html.
   
3. vsemozhetbyt commented on Feb 14, 2019

   

   vsemozhetbyt

   on Feb 14, 2019

   Contributor

   More actions

   The generation takes place here:
   

   node/tools/doc/html.js

   Lines 125 to 142 in 6f64cda

   	// Handle references to man pages, eg "open(2)" or "lchmod(2)".
   	// Returns modified text, with such refs replaced with HTML links, for example
   	// '<a href="/api/browser/proxy?url=http%3A%2F%2Fman7.org%2Flinux%2Fman-pages%2Fman2%2Fopen.2.html">open(2)</a>'.
   	function linkManPages(text) {
   	return text.replace(
   	MAN_PAGE, (match, beginning, name, number, optionalCharacter) => {
   	// Name consists of lowercase letters,
   	// number is a single digit with an optional lowercase letter.
   	const displayAs = `<code>${name}(${number}${optionalCharacter})</code>`;
   	if (BSD_ONLY_SYSCALLS.has(name)) {
   	return `${beginning}<a href="/api/browser/proxy?url=https%3A%2F%2Fwww.freebsd.org%2Fcgi%2Fman.cgi%60%3C%2Fspan%3E%20%3Cspan%20class%3D"pl-c1">+
   	`?query=${name}&sektion=${number}">${displayAs}</a>`;
   	}
   	return `${beginning}<a href="/api/browser/proxy?url=http%3A%2F%2Fman7.org%2Flinux%2Fman-pages%2Fman%3Cspan%20class%3D"pl-s1">${number}` +
   	`/${name}.${number}${optionalCharacter}.html">${displayAs}</a>`;
   	});
   	}
4. gengjiawen commented on Feb 14, 2019

   

   gengjiawen

   on Feb 14, 2019

   Last edited by gengjiawen

   Member

   More actions

   Looks like a bug. Filter curl and uname for now ?
5. 07Gond commented on Feb 27, 2019

   

   07Gond

   on Feb 27, 2019

   Contributor

   More actions

   https://linux.die.net/man/3/uname this link is for the https://github.com/nodejs/node/blob/master/doc/api/os.md generated by that snippet too.

   I think that maybe we have to do something like this following the snippet logic:

   const BSD_ONLY_SYSCALLS = new Set(['lchmod']);
   const LINUX_DIE_ONLY_SYSCALLS = new Set(['uname']);
   const HAXX_ONLY_SYSCALLS = new Set(['curl']);
   const MAN_PAGE = /(^|\s)([a-z.]+)\((\d)([a-z]?)\)/gm;
   
    // Handle references to man pages, eg "open(2)" or "lchmod(2)". 
    // Returns modified text, with such refs replaced with HTML links, for example 
    // '<a href="/api/browser/proxy?url=http%3A%2F%2Fman7.org%2Flinux%2Fman-pages%2Fman2%2Fopen.2.html">open(2)</a>'. 
    function linkManPages(text) { 
      return text.replace( 
        MAN_PAGE, (match, beginning, name, number, optionalCharacter) => { 
          // Name consists of lowercase letters, 
          // number is a single digit with an optional lowercase letter. 
          const displayAs = `<code>${name}(${number}${optionalCharacter})</code>`; 
     
          if (BSD_ONLY_SYSCALLS.has(name)) { 
           return `${beginning}<a href="/api/browser/proxy?url=https%3A%2F%2Fwww.freebsd.org%2Fcgi%2Fman.cgi%60%3C%2Fspan%3E%20%3Cspan%20class%3D"pl-c1">+ 
              `?query=${name}&sektion=${number}">${displayAs}</a>`; 
          } else if (LINUX_DIE_ONLY_SYSCALLS.has(name)) {
   		return `${beginning}<a href="/api/browser/proxy?url=https%3A%2F%2Flinux.die.net%2Fman%2F%60%3C%2Fspan%3E%20%3Cspan%20class%3D"pl-c1">+ 
              `${number}/${name}">${displayAs}</a>`; 
   	   } else if (HAXX_ONLY_SYSCALLS.has(name)) {
   		return `${beginning}<a href="/api/browser/proxy?url=https%3A%2F%2F%3Cspan%20class%3D"pl-s1">${name}.haxx.se/docs/manpage.html">${displayAs}</a>`; 
   	   } else {
          	return `${beginning}<a href="/api/browser/proxy?url=http%3A%2F%2Fman7.org%2Flinux%2Fman-pages%2Fman%3Cspan%20class%3D"pl-s1">${number}` + 
            `/${name}.${number}${optionalCharacter}.html">${displayAs}</a>`;
   	   }
        }); 
    }

   If we try this we got:
   

   If everything is ok here, Can I send a PR for this?
6. 07Gond

   added a commit that references this issue on Apr 10, 2019

   tools,doc: fix 404 broken links in docs

   ...

   eecc04c
7. vsemozhetbyt

   closed this as completedin 964174eon Apr 20, 2019
8. sjarmak

   added a commit that references this issue on Jul 27, 2026

   tools,doc: fix 404 broken links in docs

   ...

   964174e