Version website with Mike

[tsipinakis]

Changes introduced with this PR

Introduce full website versioning with mike as recommended by mkdocs docs. While we do copy old version reference docs in the reference guide mike gives some distinct advantages, namely:

1. We can version all aspects of the site including getting started, installation guides etc
2. We do not have to rebuild, curate or make sure the old documentation is buildable/looks good with new mkdocs versions, mike does not rebuild old versions of the docs and simply lets them sit in the gh-pages branch.

This commit also updates the github actions workflow to automatically push the main branch to the upcoming version and any v* branches to the respective versions.

I'll merge in a weeks time unless someone stops me for a review.

---

By contributing to this repository, I agree to the contribution guidelines.

[ghost]

FYI, this would version the entire site not just the reference manual. The reference manual needs to be restructured too and redirects should be added.

[tsipinakis]

Indeed, that's to be handled next. One case that's currently broken is that mike doesn't add redirects for old links at the root at all AFAIK. You're running a reverse proxy for containerssh.io right? Can you add a redirect of containerssh.io/foo/bar -> containerssh.io/latest/foo/bar?

Where foo != v* or upcoming or latest (the tags we're currently using)?

[tsipinakis]

Actually I might have fixed it by copying the redirect files from latest to the root.
https://containerssh.github.io/getting-started/docker/ -> https://containerssh.github.io/v0.4/getting-started/docker/ works

For some reason https://containerssh.github.io/getting-started/kubernetes/ -> https://containerssh.github.io/v0.4/getting-started/kubernetes/ doesn't though, weird. It's the same code.

In any case, currently containerssh.io 404s I assume that's some cache?

Fixed it now, it appears all is good.

[schwzr]

In any case, currently containerssh.io 404s I assume that's some cache?

To use a custom domain you need a CNAME file in the root directory of your gh-pages branch.

Currently it seems you moved the CNAME file in the v0.4-subdirectory:

https://github.com/ContainerSSH/containerssh.github.io/blob/gh-pages/v0.4/CNAME

[tsipinakis]

Ah, that explains it thanks. I was under the impression that @janosdebugs was running a reverse proxy for the domain and its cache/configuration was causing the 404. Will fix it asap.