elk
elk copied to clipboard
One documentation website per release
The ELK website should exist in several versions: one for each release (starting with the next, probably) and one for the nightly build. We currently only provide a ZIP archive with the website.
Things that need to be changed:
- The script that builds and pushes the website.
- The build configuration, probably, to introduce the name of the folder the website should be moved into for the current build.
- The website repository needs to contain a referrer to the folder that contains the documentation of the latest release.
- The website itself might benefit from a combo box to switch between documentation versions, as the Python documentation website has. There should at least be a link to switch to the nightly website.
The publish-website.sh is not checked in, correct?
- The build configuration, probably, to introduce the name of the folder the website should be moved into for the current build.
It would be enough if the script above would take care of renaming etc., wouldn't it?
- The website repository needs to contain a referrer to the folder that contains the documentation of the latest release.
What exactly do you mean by website repository? I guess a symlink could do the trick?
The
publish-website.shis not checked in, correct?
It is, see here.
It would be enough if the script above would take care of renaming etc., wouldn't it?
Hm, yeah, probably. This all depends on how one would go about compiling the website. Since we publish the release websites, it might be best to use those since they already have complete references in there. Otherwise we'd have to compile all of the old versions to generate it again... Feels like there should be easier solutions, though.
- The website repository needs to contain a referrer to the folder that contains the documentation of the latest release.
What exactly do you mean by website repository? I guess a symlink could do the trick?
My comment had to do with the way Eclipse websites work. Each website has a Git repository, from which it is published. That's not too dissimilar from what GitHub Pages does.
My preferred solution would add a combo box to the website with which users can switch between versions. The selection would only impact the Documentation and Reference sections, though.