sw360.website

Learn more »

Discussions · Website · Issues . Documentation · GSoC

The website is based on the Hugo static page generator. All relevant source files can be found at github/sw360.website (https://github.com/eclipse/sw360.website). The page is published at eclipse.org/sw360 and build with a jenkins job, which is configured in a jenkins file in the repository of the website.

If you want to add content to the page, please checkout the git repository (https://github.com/eclipse/sw360.website.git) and add your content.

The page will be build as soon as you push to upstream main branch. There is also a staging area at the Eclipse Foundation page at staging.eclipse.org/sw360, which is protected by your Eclipse Foundation user credentials and filled with the content that is fund at the staging branch in https://github.com/eclipse/sw360.website. If you want to check out your changes first, just push to the staging branch. The content is published the same way as with the main branch.

The jenkins instance is operated by the Eclipse Foundation and can be found here: https://jenkins.eclipse.org/sw360/job/sw360.website/. The result of the jenkins build is pushed to: http://git.eclipse.org/c/www.eclipse.org/sw360.git.

The jenkins jobs looks every 15 minutes after changes on the repository. If it detects changes it will start the hugo build and copy the generated static html files to git.eclipse.org. From there another job fetches the files and copies them to the actual static webspace of the Eclipse Foundation.

Table of Contents

• Prerequisites
• Local Development Using Docker
• Troubleshooting
• Project Structure
• Support

Prerequisites

Ensure you have the following installed before proceeding:

• Docker (Check installation by running docker --version in the terminal)
• Bash (Available by default on macOS and Linux; for Windows, use Git Bash or WSL)

Local Development Using Docker

If you have Docker installed on your system, you can quickly set up a local development environment and test changes in real time.

Setting Up the Local Server

1. Open a terminal and navigate to the project root directory.

2. Run the following command to start the local server:

   bash docker_serve_local.sh

3. Once the server starts, open your browser and visit:

   http://localhost:1313/sw360

4. Any changes made to the code will automatically reflect in the browser.

Troubleshooting

1. Docker is not running

Issue: bash: docker: command not found

Solution:

• Ensure Docker is installed and running.
• On macOS or Windows, open Docker Desktop.
• On Linux, start Docker with:

  sudo systemctl start docker

2. Permission issues running the script

Issue: Permission denied error when executing docker_serve_local.sh.

Solution:

• Give execution permission to the script:

  chmod +x docker_serve_local.sh

• Run it again:

  bash docker_serve_local.sh

Project Structure

sw360.website/
├── content/               # Website content (pages, posts, etc.)
├── layouts/               # Custom layout templates
├── static/                # Static assets (images, CSS, JS)
├── config.toml            # Hugo configuration
├── docker_serve_local.sh  # Docker development script
└── README.md              # Project documentation and contribution guidelines

Support

• Report issues: GitHub Issues
• Community: SW360 Mailing List
• Documentation: SW360 Documentation