Deploy separate dev-snapshots of (development) website
Currently, we only deploy new versions of the ESCET website with new releases of the toolkit. This is mostly OK for end user documentation. However, for developer documentation, this means we often look at out-of-date information. For instance, when upgrading Eclipse or Java, the instructions to set up a development environment are immediately outdated, and new contributors use old instructions, get errors in their workspace, and might just give up. Myself, I always use the sources of the development website when doing a release or so, as I know the website version is often outdated.
I think the development documentation should be regularly, say nightly, updated/redeployed. Although, we could probably easily check the commit hash of the last commit in develop
and forego the update if that matches the last-deployed development website, or so.
I see two options:
-
Still deploy a version of the development website per release: - Deploy version-specific websites as we do now.
-
Also deploy a 'current' version of the development website (https://eclipse.dev/escet/development). (see #699 (closed)) -
Link from version-specific websites to the 'current' version. See #437 (closed). - PRO: You can still look at the development website of older versions, meaning you could do development on those versions if you're not using the latest ESCET.
- CON: Multiple versions of the development website, and people could look at the wrong versions.
-
Separate the development website (the part generated with AsciiDoc) from the rest of the website: -
Version-specific websites no longer have the development
sub-directory. -
Independently, deploy the development website (https://eclipse.dev/escet/development). -
Remove release note links and other version-specific parts from the development part of the website. - PRO: Single up-to-date version of the development website for people to look at.
- CON: You can no longer look at the development website of older versions, if you want to develop for or against older versions of ESCET.
-
What do you think?