search

vaadin / platform

Vaadin platform 10+ is a Java web development platform based on Vaadin web components. If you don't know to which repository your bug report should be filed, use this and we'll move it to the right one.
https://vaadin.com
550 stars 78 forks source link

On each platform release: Update Flow version in Vaadin Docs Flow API link #523

Closed Haprog closed 5 years ago

Haprog commented 5 years ago

The problem is that in Vaadin Docs https://vaadin.com/docs for Vaadin 10+ it shows a link in the sidebar "Vaadin Flow / Flow API" which links to e.g. https://vaadin.com/api/com.vaadin/flow-server/1.0 (depending on which version of docs you are browsing).

If you leave the version out of the URL it will always redirect to latest version, if there is just 1 it will redirect to latest release of version 1, if there is 1.0 it goes to latest of that (currently 1.2.4). But we don't want to use these dynamic URLs here since then the target would be determined by latest releases of Flow even if that version of Flow is not yet included in any platform release. So we instead want to use the exact version in the link so that it links to the specific version of Flow that is included in the latest release of the selected major platform version.

These links are currently managed in:

One branch for each "version of Docs"

When Vaadin 13 beta (and so on) is released there will probably also be

Which should link to the Flow version that is included in the latest beta release of Vaadin 13 (until we have a first stable/GA version of it, after which this should always link to the version in latest stable Vaadin 13).

So basically for any vaadin<version> branch (where version >= 10) in vaadin-docs the link to Flow API in website/_data/docs.yml needs to be updated with the version number which should be the flow version that is included in the latest GA/stable release of that specific major platform version (unless there is no stable/GA version yet for that major, then use the latest prerelease version).

qtdzz commented 5 years ago