Migrate website repos to GitLab

Should be possible to migrate the CHESS website repo (https://git.eclipse.org/c/www.eclipse.org/chess.git/) to CHESS GitLab (https://gitlab.eclipse.org/eclipse/chess)?

changed title from Migrate CHESS website repo to CHESS GitLab to Migrate website repos to GitLab

I've updated the title to track the effort of supporting Gitlab repos for the website. Also, I opened an issue to investigate Gitlab pages as an easier alternative.

https://gitlab.eclipse.org/eclipsefdn/gitlab/-/issues/2

added Migration label

mentioned in issue #16 (closed)

@droy is there any update on this issue? thanks

Not yet, but we're working on it.

mentioned in issue #29 (closed)

/cc @cguindon

I think, at a high level, a GitLab project (repo) inside

PROJECTNAME's group (aptly named 'website' or something like that) would be scanned by our checkout script and published to eclipseprojects.io/

PROJECTNAME

mentioned in issue #2 (closed)

Further, we will be discontinuing the usage of www.eclipse.org/$PROJECTNAME in favour of eclipseprojects.io/$PROJECTNAME, to enhance security of the eclipse.org domain.

It's possible to use Gitlab for the source code of your website. We recently migrated the eclipse.org/dash website to gitlab a few months ago: https://gitlab.eclipse.org/eclipse/dash/dash-website

That project was built using our hugo-eclipsefdn-website-boilerplate project which aims to help our projects build a Hugo website using Eclipse Infrastructure.

This is how it works:

The website source code repo has a Jenkins file that defines how to build the website. Once the website is built, we use Jenkins to push the build to the www.eclipse.org/${PROJECT_NAME} repo. For CHESS, that repo would be https://git.eclipse.org/r/admin/repos/www.eclipse.org/chess

Thanks @cguindon. This is a very nice feature!

Could you give me support to migrate the CHESS website to Gitlab?

What are the steps for the migration?

Definitely! This would be a good test for us. I will use this to document the process for other projects.

I am assuming you want to build your website using our boilerplate https://github.com/EclipseFdn/hugo-eclipsefdn-website-boilerplate.

I think these should be the steps:

1. Ask @webmaster to provision a new git repository to host the source code of your new website in Eclipse Gitlab
2. Clone and modify https://github.com/EclipseFdn/hugo-eclipsefdn-website-boilerplate based on your project needs.
3. Push your changes to your new repo
4. Update Jenkinsfile per instructions here: https://github.com/EclipseFdn/hugo-eclipsefdn-website-boilerplate#how-to-build-my-projects-website-with-jenkins
5. Create website deployment Jenkins job
6. Ask @webmaster to install the Jenkins webhook to your website repository

@fgurr Do you think I am missing any step here?

Regarding the website deployment Jenkins job, is that something our project can do or do you need to get involved here?

mentioned in issue eclipse/escet/escet#35 (closed)

@cguindon sgtm. The CHESS project should be able to set up the Jenkins job per instructions in the wiki. The releng/webdev teams can assist depending on what kind of issues come up.

This is the wiki documentation that Frederic mentioned: https://wiki.eclipse.org/Jenkins#How_to_build_my_project.27s_website_with_Jenkins.3F

@webmaster Could you please provide the new git repository to host the source code of the new CHESS website in Eclipse Gitlab (https://gitlab.eclipse.org/eclipse/chesshttps://gitlab.eclipse.org/eclipse/chess)?

https://gitlab.eclipse.org/eclipse/chess/chess-website has been created.

Some questions:

1. Should chess webpages be manually placed in a specific folder (e.g. /static) of the new chess-website repo?
2. When the process is complete, the old website (https://www.eclipse.org/chess) will be replaced with the chess webpages located in the main branch, correct?
3. This is a portion of Jenkinsfile:

stage('Build website (staging) with Hugo') {
      when {
        branch 'staging'
      }
      steps {
        container('hugo') {
            dir('hugo') {
                sh 'hugo -b https://staging.eclipse.org/${PROJECT_NAME}/'
            }
        }
      }
    }

This means that I can use the staging branch to build a draft website on https://staging.eclipse.org?

Currently our website checkout tooling doesn't support repos anywhere other than git.eclipse.org/www.eclipse.org/project-id.git, so that will need to be changed before this content can be deployed.

-M.

I don't think Eclipse CHESS is planning to do otherwise.

@webmaster The idea here is the project is separating the source code of the website (https://gitlab.eclipse.org/eclipse/chess/chess-website) from the repo where the build result is stored (git.eclipse.org/www.eclipse.org/project-id.git).

The idea is that the Jenkins job on https://gitlab.eclipse.org/eclipse/chess/chess-website will trigger a build and will commit the output to git.eclipse.org/www.eclipse.org/project-id.git

See: https://gitlab.eclipse.org/eclipse/chess/chess-website/-/blob/master/Jenkinsfile#L54 and https://gitlab.eclipse.org/eclipse/chess/chess-website/-/blob/master/Jenkinsfile#L103

Ah, in that case, yes everything should be fine.

Our boilerplate is a website example using Hugo. You can find more information about Hugo on their documentation website: https://gohugo.io/documentation/

The idea with Hugo is that you create your content pages in markdown in the content folder. Files in the static folder are served as-is: https://gohugo.io/content-management/static-files/

Thanks for the prompt replies!

So going back to my questions, the answers are:

1. It is not possible to copy-and-paste the old website. Its content should be arranged to Hugo format.
2. Yes I suppose (https://gitlab.eclipse.org/eclipse/chess/chess-website/-/blob/master/Jenkinsfile#L72).
3. I still don't know. What's the purpose of https://staging.eclipse.org/?

@cguindon Do you agree?

Staging.eclipse.org is a test site that picks up the 'staging' branch of a website repo and deploys it. The idea is to allow projects to test updates before doing damage to their 'live' website.

1. It is not possible to copy-and-paste the old website. Its content should be arranged to Hugo format.

In theory, what you are describing here should work. However, I don't think that Hugo is the right choice for you if you don't plan to use Hugo to manage your content.

An alternative solution would be to modify your Jenkins job to push new commits to the Gerrit repo each time a change is committed to your Gitlab repo.

Yes I suppose (https://gitlab.eclipse.org/eclipse/chess/chess-website/-/blob/master/Jenkinsfile#L72)

It's important to understand that the content of eclipse.org/chess is coming from this repo: https://git.eclipse.org/r/admin/repos/www.eclipse.org/chess

However, we do understand that some projects don't want to use Gerrit for web development. Our current solution for that is Jenkins.

Projects can decide to use Github or Gitlab to manage their project website source code. To do so, the project must create a Jenkins job that will commit the website assets to the Gerrit repo. This is basically what the Jenkins example in our boilerplate project is doing.

I still don't know. What's the purpose of https://staging.eclipse.org/?

Webmaster is right. It allows you to deploy your changes to our staging server for testing purposes. You don't need to use it if you don't need it.

The staging server requires a username/password. We do this to stop Google from indexing our staging server.

username: testuser password: plaintext

Now it works! thanks.