NOTE

This project was migrated to Eclipse Gitlab on October 12, 2021.

This boilerplate was created to help Eclipse Projects migrate their website to Hugo!

Clone the project with submodules and start a web server:

git clone --recurse-submodules https://github.com/EclipseFdn/hugo-eclipsefdn-website-boilerplate
cd hugo-eclipsefdn-website-boilerplate
hugo server

The hugo-solstice-theme was added to this project as a git submodule.

git submodule update --remote

For more information, please see git documentation on submodules.

The preferred static website generator for Eclipse project websites is Hugo.

You should first put your Hugo sources in a dedicated Git repository, either at GitHub if your source code is already hosted at GitHub or at git.eclipse.org. If you don't have such a repository already, feel free to open a request, the Eclipse IT team will create one for you.

Note that each and every Eclipse project automatically gets a Git repository with git.eclipse.org/www.eclipse.org/<project_name> (see this repository index for complete list). This is not where you want to push your Hugo sources. This repository contains the webpages that are automatically and regularly pulled and published on the www.eclipse.org HTTP server. All the content from the master branch will eventually be available at the URL https://www.eclipse.org/<project_name>.

We recommend that our projects start with forking our hugo-eclipsefdn-website-boilerplate project.

Once your Hugo sources are in the proper repository, update the file named Jenkinsfile at the root of the repository with the proper value for PROJECT_NAME and PROJECT_BOT_NAME environment variable. We also expect projects to update the README.md, config.toml and all the files in the content folder.

If you don't have a Jenkins instance already, ask for one. If you need assistance with the process, open a ticket.

The Jenkinsfile example assumes that your project will use main as the default branch for your source code. Projects will need to make changes to the file to use a different branch name.

1. Fork the eclipsefdn/hugo-eclipsefdn-website-boilerplate repository
2. Clone repository: git clone --recurse-submodules https://github.com/[your_github_username]/hugo-eclipsefdn-website-boilerplate.git
3. Create your feature branch: git checkout -b my-new-feature
4. Commit your changes: git commit -m 'Add some feature' -s
5. Push feature branch: git push origin my-new-feature
6. Submit a pull request

This program and the accompanying materials are made available under the terms of the Eclipse Public License v. 2.0 which is available at http://www.eclipse.org/legal/epl-2.0.

SPDX-License-Identifier: EPL-2.0

Images, less and JavaScript files for the Eclipse Foundation look and feel.

Hugo theme of the Eclipse Foundation look and feel.

Have a bug or a feature request? Please search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Christopher Guindon (Eclipse Foundation)

• https://twitter.com/chrisguindon
• https://github.com/chrisguindon

• Eclipse® is a Trademark of the Eclipse Foundation, Inc.
• Eclipse Foundation is a Trademark of the Eclipse Foundation, Inc.

Copyright 2021 the Eclipse Foundation, Inc. and the hugo-eclipsefdn-website-boilerplate authors. Code released under the Eclipse Public License Version 2.0 (EPL-2.0).