Issue #5601: Move latest version of Maven-generated site from Sourceforge to Github IO

[daniilyar]

Here is a link to test it out on my fork: https://daniilyar.github.io/checkstyle.github.io/

[romani]

Version that you provided is "Version: 8.9-SNAPSHOT", is it what you wanted?

Why not to checkout to checkstyle-8.8 tag and build site to be the same as current active website, to be mirror.

as checkstyle/github.io repo is different repo with checkstyle/checkstyle. Please make commit message like "Issue checkstyle/checkstyle#5601: ......." to let github link commit to proper issue.

[vorburger]

@daniilyar @romani whoa, hang on - is this, a manual PR, really what we want to do here?

I thought that what you did 1 time manually here would / should instead be done automatically by a script running on CI which would build mvn clean site and AUTOMATICALLY push EVERY commit on master and all open branches into a sub-directory named after said branch into this repo...

[daniilyar]

@vorburger , I have some conversations with Hyper.sh and Rackspace to get free computing resources for Checkstyle org. When we have these we are going to setup Jenkins CI using Hyper.sh containers as dynamic Jenkins slaves to automate PRs testing, releases and site updates. But until this is done, we need to start evaluating GitHub.io by e.g. switching DTDs over. So I am doing a first move manually for now to unblock some other work.

AUTOMATICALLY push EVERY commit on master and all open branches into a sub-directory named after said branch into this repo

Why do we need to push site on every commit in master branch? IMO, what we need is for each new release automation shoud take the release tag and update the mvn site on GitHub.io from it.

[daniilyar]

@romani, thanks for comments! I've re-built from checkstyle-8.8 tag. Fixed issue link in commit description. Please review (https://daniilyar.github.io/checkstyle.github.io/)

[romani]

is this, a manual PR, really what we want to do here?

it is manual, only because it is initial to let all be on the same page of what to expect.
During release, this push should be automated.

running on CI which would build mvn clean site and AUTOMATICALLY push EVERY commit on master

only after release (version bump). If we want to have snapshot web site availbale, I am ok to keep it in web but in easy to access place, to make it clear for user where is real documentation. lets think about this after migration is done.

[romani]

PR is merged as first step to have a simple mirror placeholder, but issue is not done.

[vorburger]

conversations with Hyper.sh and Rackspace to get free computing resources for Checkstyle org

cool. I'll let you carry on here in that case - thank you!

During release, this push should be automated.
running on CI which would build mvn clean site
only after release (version bump). If we want to have snapshot web site availbale,
I am ok to keep it in web but in easy to access place,
to make it clear for user where is real documentation

personally I would publish doc sites for both, released versions and latest master SNAPSHOT via CI, in clearly named sub-directories (say /8.8/ vs /master-SNAPSHOT/, kind of thing), but up to you.