http://checkstyle.sourceforge.net ==> http://checkstyle.org

[vorburger]

Follow-up from #5574 (which I'll close) :

Reading https://sourceforge.net/p/forge/site-support/16482/, I get the feeling that it's probably a good time now for another step to move CS away from sourceforge.net? @romani in #5574 said, quote:

actually we have checkstyle.org , but we never make it used, as checkstyle is not profitable at all. And my strict position is to not use any personal resources on this to not depend on single person.

so I propose this issue to move the website that is currently on http://checkstyle.sourceforge.net to http://[wwww.]checkstyle.org. This should hopefully be possible using GitHub pages - I've done this myself for a few of my projects, and am willing to find the time to make a (small!) contribution to CS to help get this set up.

Just for the purpose of containing scope and have "actionable" issue, I also propose that this issue is strictly limited to moving the static content that today is on http://checkstyle.sourceforge.net, exactly as it is, over to a checkstyle.org.

We probably should have the discussion about what to the with the existing site - HTTP redirects? At root? On every page??

But IMHO we should use other new issues for any discussion related to "a good opportunity to revamp the site as well, as it is a bit dated." and "propose using a more modern static site generator like Jekyll (which integrates well with GitHub Pages). The upshot of doing it this way would be that the site content could just be (mostly) written with Markdown instead of xdoc." (@ntsim) nor "release uploads" related stuff (@misery) - I can only encourage anyone with bandwith to help driving those possible follow ups to this issue in new issues (which I personally will not have the capacity to help with).

So I think what that this boils down to is just (a) do a test to confirm we can host content on checkstyle.org using GitHub pages (test that CNAME thing we'll have to do), and then (b) get the Travis CI master build job to push the output produced by "mvn clean site" to where we ended up hosting the generated content for checkstyle.org - which I'm guessing will either be the "gh-pages" branch of this repo, or a new repo like www.checkstyle.org under this org; what's easier, anyone?

@romani can you confirm that you have DNS control over checkstyle.org ?

[vorburger]

do a test to confirm we can host content on checkstyle.org using GitHub pages

Would someone with the appropriate persmissions like to move my proposed and corretly configured https://github.com/vorburger/checkstyle.github.io under https://github.com/checkstyle? I obviously cannot do this myself (You don’t have the permission to create repositories on checkstyle.), so I'm guessing you have to either fork my repo into that (but that's ugly and will keep the "forked from vorburger" forever, which could be confusing in the future), or perhaps temporarily grant me that permission, let me move it, and then take that permission away again?

@romani can you confirm that you have DNS control over checkstyle.org ?

AFAIK you would have to do both this and then this DNS config. I'm happy to help out with that, if you like.

The goal is to see if we will see this test index.html on http://checkstyle.org and http://www.checkstyle.org

Background:

• https://help.github.com/articles/user-organization-and-project-pages/#user-and-organization-pages-sites
• https://help.github.com/articles/custom-domain-redirects-for-github-pages-sites/
• https://help.github.com/articles/setting-up-an-apex-domain/
• https://help.github.com/articles/setting-up-a-www-subdomain/

[romani]

@vorburger , I appreciate your desire to help. I will try to be responsive to your contributions, but I apologize in advance as there are already a lot of people are awaiting for response from me. I am ok to pin me and remind me to respond.

can you confirm that you have DNS control over checkstyle.org ?

I do not have it now.
I am trying to contact on of our former maintainers to provide me full ownership of this domain.
@daniilyar , please respond.

We probably should have the discussion about what to the with the existing site

it will stay in play till github.io web site become complete mirror of content and we found way to do automatic way to release to it. I do not expect it will be very quick, too much items to move and recheck. There are lot of nuances stick to hosting for last 17 years.
To avoid frustration .... It is better from the begging think about github.io as mirror, as it become full functional - do final updated to redirect all from sourceforge to github.io.

propose using a more modern static site generator like Jekyll (which integrates well with GitHub Pages)

completely separate and more complicated issue, lets just migrate to new hosting and all other improvements should be done as post steps.

(b) get the Travis CI master build job to push the output produced by "mvn clean site" to where we ended up hosting the generated content for checkstyle.org

It is also complicated issue, please do not even try to make it in scope of this issue, we discussed it hundreds of times, there are problems and nuances, it is not that simple but doable, and we did a lot as prestep for this. Lets not discuss this topic in this issue, let create separate if we do not have yet.

perhaps temporarily grant me that permission, let me move it, and then take that permission away again?

I might do creation of repo, just copy content, so all further updates will be by PRs as usually.
As I got understanding that your got a feeling of what we demand quality of PRs, you might get RW access to repo to pass minor (only minor) changes yourself.
Does it work for you ?

[vorburger]

contact on of our former maintainers to provide me full ownership of this domain. @daniilyar , please respond.

Otherwise, someone could also just a new domain, of course.

It is better from the begging think about github.io as mirror, as it become full functional -
do final updated to redirect all from sourceforge to github.io.

that sounds like a great plan to me.

Does it work for you ?

Whatever works for you works for me. Not sure which repo you mean now (checkstyle or checkstyle.github.io ?), but I'm actually not even asking for RW access to any repo. The only thing that should ever write to checkstyle.github.io is a build job IMHO.

[tsjensen]

Thanks @vorburger for going forward with this!

[...] either be the "gh-pages" branch of this repo, or a new repo like www.checkstyle.org under this org; what's easier, anyone?

Fwiw, I vote for a new repo like www.checkstyle.org under this org, as this will help reduce the disk size of the checkstyle repo for people that don't work on the website.

[romani]

as this will help reduce the disk size of the checkstyle repo for people that don't work on the website.

it will not help, website is generated from files of xdoc folder of repo, content is minimal in comparison to other files. Redo website to new engine is completely different issue, and far more complicated, but doable.

[vorburger]

@romani I believe you misunderstood the point that @tsjensen is trying to make - he's agreeing with having a new repo instead of using the "gh-pages" branch of this repo saves .git space in this repo, especially if we have a job that push latest (generated from xdoc as is, yes) content to it. I agree with this, and I believe you also have implicitly above, and that is why I proposed checkstyle.github.io. FYI if I understand how GitHub Pages work correctly, that repo HAS to be called exactly that, not e.g. www.checkstyle.org, because GitHub pages triggers for repo named ORGNAME.github.io.

[romani]

he's agreeing with having a new repo instead of using the "gh-pages" branch of this repo saves .git space in this repo

Yes, as branch it will never be in main repo, it is old fashioned approach of GitHub pages, right now GitHub allow to use special repo for this.

ORGNAME.github.io.

It is ok to have it like this while we try to migrate.

[romani]

I purchased checkstyle.org

[vorburger]

I purchased checkstyle.org

neat. Now you would have to do both this and then this DNS config, somewhere in DNS configuration for this domain at GoDaddy. Shout if you need any help with that.

[romani]

github.io pages repo is created - https://github.com/checkstyle/checkstyle.github.io

godaddy DNS is configured:

[romani]

@vorburger , it is not clear to me, why it redirects to your webpage ?

from https://help.github.com/articles/troubleshooting-custom-domains/

If you don't own the repository that contains the CNAME file with your custom domain, try to contact the owner and ask them to update their custom domain. If you're unsure which repository contains the CNAME file with your custom domain, contact GitHub Support.

please remove/change your CNAME file at https://github.com/vorburger/checkstyle.github.io .

[vorburger]

please remove/change your CNAME file at https://github.com/vorburger/checkstyle.github.io .

done in vorburger/checkstyle.github.io@fc67ee9, but GitHub may take a moment to realize it - let's give it some time.

[romani]

It works now, http://checkstyle.org .
Can you share plan of migration ? It it better to make it as set of simple or mid size issues. We can make GitHub project to keep track of them.

[romani]

Looks like eclipse-cs automatically become to use new domain. So we need to be accurate with domain as it is already become in use by eclipse-cs, domain is for whole organization, and eclipse-cs part of it.

[daniilyar]

@romani , @vorburger let me help with this migration. I believe I have enough rights and knowledge on Checkstyle SourceForge and GitHub to move everything properly.

[daniilyar]

One nuance will be with DTD files that are currently hosted on Sourceforge. The DTD files are referenced in people Checkstyle configs all over the world so we need to make sure we will not remove them from SourceForge as that would break the process for thousands of Checkstyle users.

I wonder if on SourceForge we can setup a reliable redirect for these DTDs pointing to github.io

[daniilyar]

PR checkstyle/checkstyle.github.io#1 adds the fresh-generated Maven site (totally 11.6 Mb in ~5k files) to GitHub.io. All pages seems to be generated properly, but @romani could you please review? Here is a link to test it out on my fork: https://daniilyar.github.io/checkstyle.github.io/

[jansohn]

The current SSL certificate is not valid for checkstyle.org so we can't use https properly. This should be fixed!

[romani]

one more reason to move out of sourceforge, long down time today, this affects circleCIs unfortunately:

$ curl http://checkstyle.sourceforge.net/dtds/import_control_1_2.dtd
Sourceforge project sites are currently under maintenance.  Please check back later.  
We thank you for your patience.

[romani]

reason of delay in release 8.12 :

ssh -t $SF_USER,checkstyle@shell.sourceforge.net create

You don't have an active shell at this time.  For basic file transfers and
management, use web.sourceforge.net -- it allows rsync, sftp, and scp access.

Shell creations are currently disabled.  Please try again at a later time.

Shared connection to shell.sourceforge.net closed.

[romani]

sourceforge.net ssh access is not working again .... make a delay in 8.15 release.

One of approach to deploy only to github.io is
https://maven.apache.org/plugins/maven-site-plugin/deploy-mojo.html#skipDeploy
second approach is:

$ git diff
diff --git a/pom.xml b/pom.xml
index 9e1bdf8..e4aa8d7 100644
--- a/pom.xml
+++ b/pom.xml
@@ -191,7 +191,7 @@
     <site>
       <id>sourceforge-new-site</id>
       <name>New Site</name>
-      <url>scp://shell.sourceforge.net/home/project-web/checkstyle/htdocs/new-site</url>
+      <url>file://${project.basedir}/../checkstyle.github.io</url>
     </site>
   </distributionManagement>

in all cases it will require small changes in release.sh.
Deploy to sourceforge.net will be done by separate script in ".ci" folder , as copy-site-to-sourceforge.sh as clone of gihub.io and existing code of substitution of htdocs folder.
Sourceforge will not be main hosting any more, and will keep old versions and some checkstyle reports for projects.

[romani]

checkstyle.org is now main web site , sourceforce is mirror if it works.

Still not done:

• figure out is it reasonable to store in github.io all old versions, to completely stop updating files on sourceforge.

[romani]

I am closing this epic issue, #7377 is leftover that we need to think about.