Display LTS and Stable API links on docs page

[phillipj]

Part of the multiple version docs discussion in #305.

Using the same URLs as we've got on the frontpage, e.g:

• v4.2.2: https://nodejs.org/dist/4.2.2/docs/api/
• v5.0.0: https://nodejs.org/api/

Are those URLs appropriate or would we want to use any of these aliases?

• latest -> v5.0.0
• latest-argon -> v4.2.2
• latest-v0.10.x -> v0.10.40
• latest-v0.12.x -> v0.12.7
• latest-v4.x -> v4.2.2
• latest-v5.x -> v5.0.0

[dominykas]

May I suggest adding "LTS" to every LTS version label? i.e. display:

• v4.2.2 LTS API
• v5.0.0 API

[rvagg]

perhaps use https://nodejs.org/docs/latest-v4.x/api/ for the link instead, you could also do the same with the v5.x link .. maybe. Also note that https://nodejs.org/docs/latest-argon/api/ is a thing if you want to reinforce the LTS name which is not a bad idea.

[phillipj]

May I suggest adding "LTS" to every LTS version label?

If so, why shouldn't we add "Stable" to v5 also?

[thefourtheye]

If so, why shouldn't we add "Stable" to v5 also?

Yes, that would be better.

[dominykas]

If so, why shouldn't we add "Stable" to v5 also?

Yes, that would be better.

No it would not.

The idea is to highlight the LTS release - if each release is labeled, then the information density increases and it becomes hard to see the trees in the forest. If the general recommendation is "when unsure - choose LTS", then LTS should be highlighted. Or, you can think about it this way - both LTS and Stable are "stable", but "LTS" is "special Stable", therefore it deserves an honorable mention.

If "unstable" / "alpha" / "beta" releases existed - they should also be marked as such (although better yet, they should only be displayed to power users, i.e. they should be absent from the lists on primary pages).

I am falling back on the laws of simplicity here - Simplicity is about subtracting the obvious, and adding the meaningful. - but similar concepts can be found in plenty of other generic usability advice.

[phillipj]

This if statement was put into place before we had Stable and LTS on the website - as that's old news, it could be removed.

[phillipj]

Just pushed a couple of updates:

• Use https://nodejs.org/docs/latest-v4.x/api/ and latest-v5.x URLs
• To reduce duplication and ensure consistency, I extracted docs URL generation into a Handlebars helper, which is also used on the frontpage
• Added "LTS" behind v4.x label

TBH I dont have a strong opinion about putting LTS into the v4.x link or not, but I agree with @dominykas reasoning.

[phillipj]

An updated screenshot now that we've got the Guides link aswell.

Any thoughts on this anyone? It's ready to go as soon as it gets a collaborator thumbs up.

[rnsloan]

👍

[bnb]

-1 on the last proposed solution.

LTS and Stable should both be marked - giving context to one and withholding context from other is a very bad idea.

Additionally, from a design view, there is Way too much going on in the green links, making them extremely hard for humans to parse. Having a v, number, full stop, number, full stop, number, full stop, text element one, text element two is far too much. We need to simplify this.

So here are my suggestions:

• Remove v - giving the number implies version
• Remove LTS from 4.2.2
• Append LTS and Stable in smaller gray lettering or a gray tag

[rnsloan]

When you have an LTS version of software, personally, I have never found the need to state everywhere that the later release is stable. Ubuntu do not do it: http://www.ubuntu.com/server , https://help.ubuntu.com/

[dominykas]

@bnb you're assuming the reader knows the difference between "LTS" and "Stable" - the label needs to highlight it - both are "Stable", but only one is "LTS".

[bnb]

@rnsloan @dominykas Fair play. However, I still maintain that those changes (minus adding Stable) should be made.

[phillipj]

Something like this @bnb?

[stevemao]

Looks good :)

[phillipj]

Thanks for the feedback everyone! 👍

@bnb I like your thoughts about removing the v from v4.2.3 and v5.1.1! I thought it better fits a new PR/issue, as it should probably be done throughout the site, not only the docs page - up for grabs anyone :)