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

node js api document should link to LTS release from each page #10726

Closed
toddself opened this issue Jan 10, 2017 · 6 comments
Closed

node js api document should link to LTS release from each page #10726

toddself opened this issue Jan 10, 2017 · 6 comments
Labels
doc Issues and PRs related to the documentations. feature request Issues that request new features to be added to Node.js.

Comments

@toddself
Copy link
Contributor

The API documentation for the LTS stuff is a little hidden on the site -- you have to either know the LTS doc URL or always enter it from the front door, whereas nodejs.org/api is quite easy to remember.

It would be really nice if the documentation for the "live" release had a link on that page to the relevant documentation for the LTS version (if it exists).

The postgres documentation is actually an excellent example of this:
image

Each page has a link to various other supported (and even non-supported!) versions which makes it very easy to hop to the correct version that you're using.
@mscdex mscdex added doc Issues and PRs related to the documentations. feature request Issues that request new features to be added to Node.js. labels Jan 10, 2017
@MylesBorins MylesBorins added the good first issue Issues that are suitable for first-time contributors. label Jan 10, 2017
@MylesBorins
Copy link
Contributor

This is a great idea! I've added the good first contribution tag

/cc @nodejs/documentation

@benjamingr
Copy link
Member

Sounds good to me +1

Let's give new contributors a chance to write this and do this ourselves if no one steps up.

@thefourtheye thefourtheye mentioned this issue Jan 10, 2017
Closed
@sam-github
Copy link
Contributor

/cc @nodejs/website

@chris--young
Copy link

I'll take a stab at this if that's alright. It'd probably be best to build it into doc/template.html right?

@chris--young chris--young mentioned this issue Jan 23, 2017
Closed
3 tasks
@Trott
Copy link
Member

Trott commented Jan 31, 2017

This has an open PR for it, so I'm going to remove the "good first contribution" label to keep it from showing up for people who are looking for something that is available. Feel free to re-add the label if you think that's misguided of me.

@Trott Trott removed the good first issue Issues that are suitable for first-time contributors. label Jan 31, 2017
@Trott
Copy link
Member

Trott commented Jul 16, 2017

PR for this is at #10958.

chris--young pushed a commit to chris--young/node that referenced this issue Jul 16, 2017
doc: add links to alternative versions of doc
1d10887 
Each page of the api documentation should have links to other versions
of the same page. This will make it easier to switch between the current
"live" release at nodejs.org and LTS versions.

Fixes: nodejs#10726
chris--young pushed a commit to chris--young/node that referenced this issue Jul 16, 2017
doc: fixes version labeling of alt doc links
c21e62b 
v0.12.x is no longer LTS, and v7.x should not be labeled as
"unsupported"

Fixes: nodejs#10726
chris--young pushed a commit to chris--young/node that referenced this issue Jul 16, 2017
doc: removes redudant if from version labels
0e35692 
Fixes: nodejs#10726
chris--young pushed a commit to chris--young/node that referenced this issue Jul 16, 2017
doc: renamed 'doc_created' comment tags
e161b83 
Fixes: nodejs#10726
chris--young pushed a commit to chris--young/node that referenced this issue Jul 16, 2017
doc: corrected api doc dates for crypto & debugger
334ff51 
Fixes: nodejs#10726
chris--young pushed a commit to chris--young/node that referenced this issue Jul 17, 2017
doc: updated links so version 8 is latest
4d7fd63 
Fixes: nodejs#10726
chris--young pushed a commit to chris--young/node that referenced this issue Jul 23, 2017
doc: moved version links into a dropdown
cb4622f 
Fixes: nodejs#10726
chris--young pushed a commit to chris--young/node that referenced this issue Aug 26, 2017
doc: addressed misc review comments
d01c036 
Fixes: nodejs#10726
chris--young pushed a commit to chris--young/node that referenced this issue Aug 26, 2017
doc: use better regex
967cdba 
Fixes: nodejs#10726
chris--young pushed a commit to chris--young/node that referenced this issue Aug 28, 2017
doc: made version links fit in mobile view size
6e113e2 
Fixes: nodejs#10726
ghost pushed a commit to ayojs/ayo that referenced this issue Aug 30, 2017
doc: add links to alternative versions of doc
464ca91 
Each page of the API documentation should have links to other versions
of the same page. This will make it easier to switch between the current
"live" release at nodejs.org and LTS versions.

PR-URL: nodejs/node#10958
Fixes: nodejs/node#10726
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: Evan Lucas <[email protected]>
Reviewed-By: Sakthipriyan Vairamani <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
ghost pushed a commit to ayojs/ayo that referenced this issue Aug 30, 2017
doc: add links to alternative versions of doc
fd679fc 
Each page of the API documentation should have links to other versions
of the same page. This will make it easier to switch between the current
"live" release at nodejs.org and LTS versions.

PR-URL: nodejs/node#10958
Fixes: nodejs/node#10726
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: Evan Lucas <[email protected]>
Reviewed-By: Sakthipriyan Vairamani <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
cjihrig pushed a commit to cjihrig/node that referenced this issue Aug 31, 2017
@cjihrig
doc: add links to alternative versions of doc
b3f7345 
Each page of the API documentation should have links to other versions
of the same page. This will make it easier to switch between the current
"live" release at nodejs.org and LTS versions.

PR-URL: nodejs#10958
Fixes: nodejs#10726
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: Evan Lucas <[email protected]>
Reviewed-By: Sakthipriyan Vairamani <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
MylesBorins pushed a commit that referenced this issue Sep 10, 2017
@MylesBorins
doc: add links to alternative versions of doc
0458b71 
Each page of the API documentation should have links to other versions
of the same page. This will make it easier to switch between the current
"live" release at nodejs.org and LTS versions.

PR-URL: #10958
Fixes: #10726
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: Evan Lucas <[email protected]>
Reviewed-By: Sakthipriyan Vairamani <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
MylesBorins pushed a commit that referenced this issue Sep 12, 2017
@MylesBorins
doc: add links to alternative versions of doc
feeff48 
Each page of the API documentation should have links to other versions
of the same page. This will make it easier to switch between the current
"live" release at nodejs.org and LTS versions.

PR-URL: #10958
Fixes: #10726
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: Evan Lucas <[email protected]>
Reviewed-By: Sakthipriyan Vairamani <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
chris--young pushed a commit to chris--young/node that referenced this issue Sep 29, 2017
doc: add links to alternative versions of doc
df440de 
Each page of the API documentation should have links to other versions
of the same page. This will make it easier to switch between the current
"live" release at nodejs.org and LTS versions.

PR-URL: nodejs#10958
Fixes: nodejs#10726
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: Evan Lucas <[email protected]>
Reviewed-By: Sakthipriyan Vairamani <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
MylesBorins pushed a commit that referenced this issue Sep 29, 2017
@MylesBorins
doc: add links to alternative versions of doc
ecea33b 
Each page of the API documentation should have links to other versions
of the same page. This will make it easier to switch between the current
"live" release at nodejs.org and LTS versions.

Backport-PR-URL: #15670
PR-URL: #10958
Fixes: #10726
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: Evan Lucas <[email protected]>
Reviewed-By: Sakthipriyan Vairamani <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. feature request Issues that request new features to be added to Node.js.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: add links to alternative versions of doc chris--young/node
7 participants
@sam-github @mscdex @toddself @MylesBorins @Trott @benjamingr @chris--young