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

http2,doc: links missing definition #14857

Closed
refack opened this issue Aug 16, 2017 · 2 comments
Closed

http2,doc: links missing definition #14857

refack opened this issue Aug 16, 2017 · 2 comments
Labels
doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors. http2 Issues or PRs related to the http2 subsystem.

Comments

@refack
Copy link
Contributor

refack commented Aug 16, 2017

  • Version: 8.4.0
  • Platform: *
  • Subsystem: doc

https://nodejs.org/api/http2.html & https://github.com/nodejs/node/blob/master/doc/api/http2.md are rendered with [...][] around links that don't have a definition (in the footer).

For example:

node/doc/api/http2.md

Lines 1904 to 1907 in 85d7d97

A `Http2ServerRequest` object is created by [`http2.Server`][] or
[`http2.SecureServer`][] and passed as the first argument to the
[`'request'`][] event. It may be used to access a request status, headers and
data.

image

@refack refack added doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors. http2 Issues or PRs related to the http2 subsystem. labels Aug 16, 2017
@refack refack mentioned this issue Aug 16, 2017
4 tasks
@thelostone-mc
Copy link
Contributor

@refack Calling dibs if it hasn't been addressed yet ^_^

Also http2 vs http ? Scenarios/ Benefits of using the former over the latter?

@sharababy
Copy link
Contributor

sharababy commented Aug 17, 2017

@refack
Hi , I have added the link definitions to the footer and pushed it to my fork.
https://github.com/sharababy/node/commit/e04feca80619af35480dbb35e52264623b28c0b8

EDIT: So silly of me , I have only added 2 such links in this commit , I am adding the rest of them now. I thought these were the only 2 such instances.

UPDATE: New commit with all changes is here : https://github.com/sharababy/node/commit/8b67046c677d84c8c4fa1ecf51d75119b42f5c51

@refack refack added the wip Issues and PRs that are still a work in progress. label Aug 19, 2017
@refack refack removed the wip Issues and PRs that are still a work in progress. label Aug 23, 2017
MylesBorins pushed a commit that referenced this issue Sep 10, 2017
PR-URL: #14946
Fixes: #14857
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: James M Snell <[email protected]>
MylesBorins pushed a commit that referenced this issue Sep 12, 2017
PR-URL: #14946
Fixes: #14857
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: James M Snell <[email protected]>
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. good first issue Issues that are suitable for first-time contributors. http2 Issues or PRs related to the http2 subsystem.
Projects
None yet
Development

No branches or pull requests

3 participants