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.

Sign up for GitHub

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

Jump to bottom

doc: rename HTTP2 to HTTP/2 #19603

Closed
wants to merge 1 commit into from
Closed

doc: rename HTTP2 to HTTP/2 #19603

wants to merge 1 commit into from

Conversation

TimothyGu
Copy link
Member

Previously, "HTTP/2" was strictly used to describe the protocol, and HTTP2 the module. This distinction is unnecessary in my opinion. Consistency between the two terms is enforced in this PR.

Checklist

@TimothyGu
doc: rename HTTP2 to HTTP/2
ff1328e 
Previously, "HTTP/2" was strictly used to describe the protocol, and
HTTP2 the module. This distinction is deemed unnecessary, and
consistency between the two terms is enforced.
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory. labels Mar 26, 2018
@TimothyGu TimothyGu added http2 Issues or PRs related to the http2 subsystem. and removed tools Issues and PRs related to the tools directory. labels Mar 26, 2018
@trivikr
Copy link
Member

trivikr commented Mar 26, 2018

/cc @jasnell @nodejs/http2

@mcollina
Copy link
Member

Every module in our doc is identified by the exact name through which it can be required. Following this pattern HTTP is http and HTTP/2 is http2. Also, the file name is http2.html, which is consistent in keeping it without the /.

I'm -1 in changing this because of the conventions in the rest of core.

@TimothyGu
Copy link
Member Author

@mcollina That is not quite true.

  • child_process.html: "Child Processes" in table of contents
  • dgram.html: "UDP/Datagram" in ToC, "UDP / Datagram Sockets" as title of page
  • fs.html: "File System" for both
  • perf_hooks.html: "Performance Hooks" in ToC, "Performance Timing API" as title of page
  • util.html: "Utilities" in ToC, "Util" as title of page

In fact, even http2.html has "HTTP/2" in the table of contents, so this change would indeed increase consistency.

@mcollina
Copy link
Member

I compared to http and https, which is what this would be compared against most of the time. However, it would improve consistency with the rest of core.

I’m lifting my -1, as I would still prefer it to stay as http2, just not blocking.

@vsemozhetbyt
Copy link
Contributor

vsemozhetbyt commented Mar 26, 2018 •
edited
Loading

Doc changes LGTM. As for the rest doubts, I am not competent enough to judge)

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite/339/

@trivikr trivikr added the fast-track PRs that do not need to wait for 48 hours to land. label Mar 26, 2018
@trivikr
Copy link
Member

trivikr commented Mar 26, 2018

CI-lite https://ci.nodejs.org/job/node-test-pull-request-lite/342/

@trivikr
Copy link
Member

trivikr commented Mar 26, 2018

Landed in 9396b77

@trivikr trivikr closed this Mar 26, 2018
trivikr pushed a commit that referenced this pull request Mar 26, 2018
@TimothyGu @trivikr
doc: rename HTTP2 to HTTP/2
9396b77 
Previously, "HTTP/2" was strictly used to describe the protocol, and
HTTP2 the module. This distinction is deemed unnecessary, and
consistency between the two terms is enforced.

PR-URL: #19603
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Chen Gang <gangc.cxy@foxmail.com>
Reviewed-By: Shingo Inoue <leko.noor@gmail.com>
targos pushed a commit that referenced this pull request Mar 27, 2018
@TimothyGu @targos
doc: rename HTTP2 to HTTP/2
8653c42 
Previously, "HTTP/2" was strictly used to describe the protocol, and
HTTP2 the module. This distinction is deemed unnecessary, and
consistency between the two terms is enforced.

PR-URL: #19603
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Chen Gang <gangc.cxy@foxmail.com>
Reviewed-By: Shingo Inoue <leko.noor@gmail.com>
kjin pushed a commit to kjin/node that referenced this pull request May 1, 2018
@TimothyGu @kjin
doc: rename HTTP2 to HTTP/2
f6387a4 
Previously, "HTTP/2" was strictly used to describe the protocol, and
HTTP2 the module. This distinction is deemed unnecessary, and
consistency between the two terms is enforced.

PR-URL: nodejs#19603
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Chen Gang <gangc.cxy@foxmail.com>
Reviewed-By: Shingo Inoue <leko.noor@gmail.com>
MylesBorins pushed a commit that referenced this pull request May 2, 2018
@TimothyGu @MylesBorins
doc: rename HTTP2 to HTTP/2
8f55971 
Previously, "HTTP/2" was strictly used to describe the protocol, and
HTTP2 the module. This distinction is deemed unnecessary, and
consistency between the two terms is enforced.

Backport-PR-URL: #20456
PR-URL: #19603
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Chen Gang <gangc.cxy@foxmail.com>
Reviewed-By: Shingo Inoue <leko.noor@gmail.com>
@MylesBorins MylesBorins mentioned this pull request May 2, 2018
Merged
MylesBorins pushed a commit that referenced this pull request May 15, 2018
@TimothyGu @MylesBorins
doc: rename HTTP2 to HTTP/2
35d35d7 
Previously, "HTTP/2" was strictly used to describe the protocol, and
HTTP2 the module. This distinction is deemed unnecessary, and
consistency between the two terms is enforced.

Backport-PR-URL: #20456
PR-URL: #19603
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Chen Gang <gangc.cxy@foxmail.com>
Reviewed-By: Shingo Inoue <leko.noor@gmail.com>
MylesBorins pushed a commit that referenced this pull request May 15, 2018
@TimothyGu @MylesBorins
doc: rename HTTP2 to HTTP/2
f59eab0 
Previously, "HTTP/2" was strictly used to describe the protocol, and
HTTP2 the module. This distinction is deemed unnecessary, and
consistency between the two terms is enforced.

Backport-PR-URL: #20456
PR-URL: #19603
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Chen Gang <gangc.cxy@foxmail.com>
Reviewed-By: Shingo Inoue <leko.noor@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@trivikr trivikr trivikr approved these changes

@ckotzbauer ckotzbauer ckotzbauer approved these changes

@MoonBall MoonBall MoonBall approved these changes

@vsemozhetbyt vsemozhetbyt vsemozhetbyt approved these changes

@tniessen tniessen tniessen approved these changes

@cjihrig cjihrig cjihrig approved these changes

@Leko Leko Leko approved these changes

@jasnell jasnell jasnell approved these changes

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. http2 Issues or PRs related to the http2 subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.