Skip to content
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

doc: autogenerated links with 404 status #17637

Closed
vsemozhetbyt opened this issue Dec 12, 2017 · 7 comments
Closed

doc: autogenerated links with 404 status #17637

vsemozhetbyt opened this issue Dec 12, 2017 · 7 comments
Labels
doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory.

Comments

@vsemozhetbyt
Copy link
Contributor

There are some links in the docs that get 404 recently:

http://man7.org/linux/man-pages/man1/curl.1.html in repl.html (1 link).
http://man7.org/linux/man-pages/man3/uname.3.html in os.html (3 links).

They are wrongly rendered:

l

They have been fixed with manually added URLs in #10244 and #15463, but have been reverted to autogenerated URLs (with autogenerated URLs being prioritized/rewritten above manual URLs) in the #17479

cc @DiegoRBaquero and @apapirovski as maybe more well-informed about the tools/doc/html.js script.

@vsemozhetbyt vsemozhetbyt added doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory. labels Dec 12, 2017
@DiegoRBaquero
Copy link
Contributor

DiegoRBaquero commented Dec 12, 2017

Manually linked links shouldn't be matched.

But also:

uname should be pointed to http://man7.org/linux/man-pages/man1/uname.1.html, shouldn't it?

And curl's manpage is fixed to one section, always updated. Maybe remove the section?

@vsemozhetbyt
Copy link
Contributor Author

vsemozhetbyt commented Dec 12, 2017

It seems they are matched because of bottom reference format: [curl(1)][] is matched now after space is replaced by \b.

I am not well aware of UNIX manpages system, those manual URLs were advised by other collaborators, so I only have alerted the issue here, sorry) Feel free to fix in any appropriate way)

@vsemozhetbyt
Copy link
Contributor Author

vsemozhetbyt commented Dec 12, 2017

Maybe we should just change \b to [^\B[] to exclude this link format from redundant autoconversion? I am not sure there will be no new side effects though.

@vsemozhetbyt
Copy link
Contributor Author

See also #17694

DiegoRBaquero added a commit to DiegoRBaquero/node that referenced this issue Dec 18, 2017
The change to word boundary was breaking many doc pages. This reverts the word boundary back to space.

Fixes: nodejs#17637
Fixes: nodejs#17694
Refs: nodejs#17479
@Trott
Copy link
Member

Trott commented Dec 18, 2017

Maybe replace word boundary \b with an allowance for spaces or the beginning of a line (^|\s). That will stop it from replacing if the word break is a non-alpha symbol like [ and ( but still work at the start of a line.

DiegoRBaquero added a commit to DiegoRBaquero/node that referenced this issue Dec 19, 2017
The change to word boundary was breaking many doc pages. This replace the word boundary with a matching group of space or beginning of line.

Fixes: nodejs#17637
Fixes: nodejs#17694
Refs: nodejs#17479
@maclover7
Copy link
Contributor

Hmmmm, so I didn't think #17724 would fix this (was focusing on the child process doc issue when landing), but looks like it did locally on my machine. Are other people seeing this too? You can verify by checking for curl(1) in repl, and uname(3) in os. Going to let the nightly run and check back tomorrow.

@vsemozhetbyt
Copy link
Contributor Author

As per the last nightly, this seems to be fixed as well. Thanks!)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory.
Projects
None yet
Development

No branches or pull requests

4 participants