Link to breaking changes

[Marsup]

Following a discussion on gitter, it seems we're doing a bad job at showing breaking changes for users not following closely the project or upgrading from old versions.

We could either link to the release notes on github or parse them to show it on the websites, what do you think ? Other ideas ?

[hueniverse]

Sounds like a good idea.

[AdriVanHoudt]

The release notes are on the updates page but maybe make them more visible and link to the updates page from the readme?

[Marsup]

They are, but spread over several pages. Imagine having to go from 8 to 11 without knowing how we use labels in the org, not that easy.

[AdriVanHoudt]

hmm true, maybe link to major releases on the left (a menu like on /api) with links to the release notes?

[nlf]

yeah, i think a small "release notes" section above the full changelog on the updates page would make sense

[devinivy]

Although I send people to the website and like to think that the website is the clear go-to for hapijs information, I think we might need to be more overt/explicit in the readme about where to find certain crucial information. I imagine people will putz around github for ages (not understanding our system) before going to the site. Most framework sites aren't as extensive as hapijs.com.

[SanderElias]

HI, I was the one raising the issue.
@AdriVanHoudt, That would be a good place. Also a remark that the breaking changes are (very well) documented in there would help some people.

[AdriVanHoudt]

I saw something pass by on Gitter :P how would you place that remark?

[SanderElias]

@AdriVanHoudt: "Major versions Release notes including breaking changes"?

[AdriVanHoudt]

seems like this is still an issue hapijs/hapi#3241

[hulbert]

Somewhat related to this (can open a new issue if appropriate) 14.0.0 shows "Release notes" next to it but 15.0.0 does not, despite this issue existing.