Skip to content

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

Closed
Trott wants to merge 2 commits intonodejs:masterfrom
Trott:altdocs-fix
Closed

tools,doc: fix version picker bug in html.js#24638
Trott wants to merge 2 commits intonodejs:masterfrom
Trott:altdocs-fix

Conversation

@Trott
Copy link
Copy Markdown
Member

@Trott Trott 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
cba8b24 
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
@Trott Trott added doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory. labels Nov 25, 2018
@nodejs-github-bot
Copy link
Copy Markdown
Collaborator

nodejs-github-bot 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
Copy link
Copy Markdown
Member Author

Trott commented Nov 25, 2018

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

@Trott Trott mentioned this pull request Nov 25, 2018
Closed
vsemozhetbyt
vsemozhetbyt reviewed Nov 25, 2018
View reviewed changes
Comment thread test/doctool/test-doctool-html.js Outdated
@vsemozhetbyt vsemozhetbyt added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Nov 25, 2018
@Trott
Copy link
Copy Markdown
Member Author

Trott commented Nov 25, 2018

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

@Trott
Copy link
Copy Markdown
Member Author

Trott commented Nov 25, 2018

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

@refack
Copy link
Copy Markdown
Contributor

refack commented Nov 25, 2018 •
edited
Loading

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

@Trott
Copy link
Copy Markdown
Member Author

Trott 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.)

@refack
Copy link
Copy Markdown
Contributor

refack commented Nov 26, 2018

💯
Just wanted to manage expectations.

@Trott
Copy link
Copy Markdown
Member Author

Trott commented Nov 28, 2018

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

@Trott
Copy link
Copy Markdown
Member Author

Trott 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
6f64cda 
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 <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Franziska Hinkelmann <[email protected]>
targos pushed a commit that referenced this pull request Nov 28, 2018
@Trott @targos
tools,doc: fix version picker bug in html.js
1625329 
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 <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Franziska Hinkelmann <[email protected]>
@BridgeAR BridgeAR mentioned this pull request Dec 5, 2018
Merged
4 tasks
This was referenced Dec 7, 2018
Closed
Closed
Closed
Closed
@beevelop beevelop mentioned this pull request Dec 8, 2018
Closed
refack pushed a commit to refack/node that referenced this pull request Jan 14, 2019
@Trott @refack
tools,doc: fix version picker bug in html.js
36fda35 
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 <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Franziska Hinkelmann <[email protected]>
BethGriggs pushed a commit that referenced this pull request Feb 12, 2019
@Trott @BethGriggs
tools,doc: fix version picker bug in html.js
f9933ff 
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 <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Franziska Hinkelmann <[email protected]>
@BethGriggs BethGriggs mentioned this pull request Feb 12, 2019
Merged
rvagg pushed a commit that referenced this pull request Feb 28, 2019
@Trott @rvagg
tools,doc: fix version picker bug in html.js
4dd89b3 
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 <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Franziska Hinkelmann <[email protected]>
@Trott Trott deleted the altdocs-fix branch January 13, 2022 22:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@fhinkel fhinkel fhinkel approved these changes

@lpinca lpinca lpinca approved these changes

@BridgeAR BridgeAR BridgeAR approved these changes

+3 more reviewers

@refack refack refack approved these changes

@vsemozhetbyt vsemozhetbyt vsemozhetbyt approved these changes

@js-kyle js-kyle js-kyle approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

docs: Version switcher is broken / misleading

8 participants

@Trott @nodejs-github-bot @refack @fhinkel @lpinca @BridgeAR @vsemozhetbyt @js-kyle