★ wanayoo — archive 1999 https://github.com/nodejs/node/pull/24638Nouvelle recherche | Portail wanayoo
Skip to content

/node

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

tools,doc: fix version picker bug in html.js #24638

Closed
wants to merge 2 commits into from

Conversation

@Trott
Copy link
Member

commented Nov 25, 2018

The processing of strings like 8.x into a major version number and a
minor version number results in minor versions that are NaN. In that
situation, since the picker will link to the latest docs in the
major version, include the version in the version picker.

Fixes: #23979

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • commit message follows commit guidelines
@Trott
tools,doc: fix version picker bug in html.js 
The processing of strings like `8.x` into a major version number and a
minor version number results in minor versions that are `NaN`. In that
situation, since the picker will link to the latest docs in the
major version, include the version in the version picker.

Fixes: #23979
Loading status checks…
cba8b24

@Trott Trott added doc tools labels Nov 25, 2018

@nodejs-github-bot

This comment has been minimized.

Sign in to view
Copy link

commented Nov 25, 2018

@Trott build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/1699/pipeline
@Trott

This comment has been minimized.

Sign in to view
Copy link
Member Author

commented Nov 25, 2018

CI: https://ci.nodejs.org/job/node-test-pull-request/18958/
@Trott Trott referenced this pull request Nov 25, 2018
Closed
@vsemozhetbyt
vsemozhetbyt reviewed Nov 25, 2018
View changes
test/doctool/test-doctool-html.js Outdated Show resolved Hide resolved
@vsemozhetbyt
vsemozhetbyt approved these changes Nov 25, 2018
View changes
@BridgeAR
BridgeAR approved these changes Nov 25, 2018
View changes

@vsemozhetbyt vsemozhetbyt added the author ready label Nov 25, 2018

@Trott
fixup! tools,doc: fix version picker bug in html.js
Loading status checks…
f0f0262
@Trott

This comment has been minimized.

Sign in to view
Copy link
Member Author

commented Nov 25, 2018

CI: https://ci.nodejs.org/job/node-test-pull-request/18962/
@refack
refack approved these changes Nov 25, 2018
View changes
@Trott

This comment has been minimized.

Sign in to view
Copy link
Member Author

commented Nov 25, 2018

Resume Build CI: https://ci.nodejs.org/job/node-test-pull-request/18963/
@refack

This comment has been minimized.

Sign in to view
Copy link
Member

commented Nov 25, 2018 •
edited

IIUC this will not fix already published documentation packages, right?
@Trott

This comment has been minimized.

Sign in to view
Copy link
Member Author

commented Nov 25, 2018

IIUC this will not fix already published documentation packages, right?

Correct, but it will fix all the HTML versions of the docs hosted on the website for currently-supported release lines. I think that's sufficient. I don't think this warrants digging into 13 previous 8.x releases to correct a menu item in one or two files. It's a fair amount of work and I'm not sure that the messing-with-history is worth it? (We don't go back and change outright errors in docs for previous versions, and that would seem to be a lot more significant.)
@lpinca
lpinca approved these changes Nov 25, 2018
View changes
@refack

This comment has been minimized.

Sign in to view
Copy link
Member

commented Nov 26, 2018

💯
Just wanted to manage expectations.
@js-kyle
js-kyle approved these changes Nov 26, 2018
View changes
@fhinkel
fhinkel approved these changes Nov 27, 2018
View changes
@Trott

This comment has been minimized.

Sign in to view
Copy link
Member Author

commented Nov 28, 2018

Resume Build CI: https://ci.nodejs.org/job/node-test-pull-request/18968/
@Trott

This comment has been minimized.

Sign in to view
Copy link
Member Author

commented Nov 28, 2018

Landed in 6f64cda

@Trott Trott closed this Nov 28, 2018

Trott added a commit to Trott/io.js that referenced this pull request Nov 28, 2018
@Trott
tools,doc: fix version picker bug in html.js 
The processing of strings like `8.x` into a major version number and a
minor version number results in minor versions that are `NaN`. In that
situation, since the picker will link to the latest docs in the
major version, include the version in the version picker.

Fixes: nodejs#23979
PR-URL: nodejs#24638
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
6f64cda
targos added a commit that referenced this pull request Nov 28, 2018
@Trott @targos
tools,doc: fix version picker bug in html.js 
The processing of strings like `8.x` into a major version number and a
minor version number results in minor versions that are `NaN`. In that
situation, since the picker will link to the latest docs in the
major version, include the version in the version picker.

Fixes: #23979
PR-URL: #24638
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Verified
This commit was signed with a verified signature.
targos Michaël Zasso
GPG key ID: 770F7A9A5AE15600 Learn about signing commits
1625329
@BridgeAR BridgeAR referenced this pull request Dec 5, 2018
Merged
4 of 4 tasks complete
This was referenced Dec 7, 2018
Closed
Closed
Closed
Closed
@beevelop beevelop referenced this pull request Dec 8, 2018
Closed
refack added a commit to refack/node that referenced this pull request Jan 14, 2019
@Trott @refack
tools,doc: fix version picker bug in html.js 
The processing of strings like `8.x` into a major version number and a
minor version number results in minor versions that are `NaN`. In that
situation, since the picker will link to the latest docs in the
major version, include the version in the version picker.

Fixes: nodejs#23979
PR-URL: nodejs#24638
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
36fda35
BethGriggs added a commit that referenced this pull request Feb 12, 2019
@Trott @BethGriggs
tools,doc: fix version picker bug in html.js 
The processing of strings like `8.x` into a major version number and a
minor version number results in minor versions that are `NaN`. In that
situation, since the picker will link to the latest docs in the
major version, include the version in the version picker.

Fixes: #23979
PR-URL: #24638
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Verified
This commit was signed with a verified signature.
BethGriggs Bethany Nicolle Griggs
GPG key ID: D7062848A1AB005C Learn about signing commits
f9933ff
@BethGriggs BethGriggs referenced this pull request Feb 12, 2019
Merged
rvagg added a commit that referenced this pull request Feb 28, 2019
@Trott @rvagg
tools,doc: fix version picker bug in html.js 
The processing of strings like `8.x` into a major version number and a
minor version number results in minor versions that are `NaN`. In that
situation, since the picker will link to the latest docs in the
major version, include the version in the version picker.

Fixes: #23979
PR-URL: #24638
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
4dd89b3
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@refack refack

@fhinkel fhinkel

@lpinca lpinca

@BridgeAR BridgeAR

@vsemozhetbyt vsemozhetbyt

@js-kyle js-kyle

Assignees
No one assigned
Labels
author ready doc tools
Projects
None yet
Milestone
No milestone
8 participants
@Trott @nodejs-github-bot @refack @fhinkel @lpinca @BridgeAR @vsemozhetbyt @js-kyle
You can’t perform that action at this time.