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

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
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

@Trott Trott added doc tools labels Nov 25, 2018

@Trott

This comment has been minimized.

Copy link
Member Author

commented Nov 25, 2018

@Trott

This comment has been minimized.

Copy link
Member Author

commented Nov 25, 2018

@refack
refack approved these changes Nov 25, 2018
@Trott

This comment has been minimized.

Copy link
Member Author

commented Nov 25, 2018

@refack

This comment has been minimized.

Copy link
Member

commented Nov 25, 2018

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

@Trott

This comment has been minimized.

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
@refack

This comment has been minimized.

Copy link
Member

commented Nov 26, 2018

💯
Just wanted to manage expectations.

@Trott

This comment has been minimized.

Copy link
Member Author

commented Nov 28, 2018

@Trott

This comment has been minimized.

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
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>
targos added a commit that referenced this pull request Nov 28, 2018
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>
@BridgeAR BridgeAR referenced this pull request Dec 5, 2018
4 of 4 tasks complete
refack added a commit to refack/node that referenced this pull request Jan 14, 2019
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>
BethGriggs added a commit that referenced this pull request Feb 12, 2019
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>
@BethGriggs BethGriggs referenced this pull request Feb 12, 2019
rvagg added a commit that referenced this pull request Feb 28, 2019
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
8 participants
You can’t perform that action at this time.