Overview

This repository contains documentation for projects under Konveyor.io

• Leverages Hugo
• Is served at: https://konveyor.github.io/
  • Assets are built and served from the branch gh-pages

Getting Started, how to run locally

1. Fork or Clone the repository, ensure you check out the configured git submodules

   • Example:

     git clone https://github.com/konveyor/konveyor.github.io.git --recursive

     • We are using the ```--recursive`` command line flag to automatically clone a few themes which Hugo will use. These are leveraging git submodules
2. cd konveyor.github.io
3. hugo server -D
   • Run the hugo server locally, building posts that may be in 'draft'
4. Visit http://localhost:1313/ in your web browser

How changes get published to 'production'

All changes which merge to 'main' will trigger a GitHub Action to run that builds the hugo assets and publishes to the gh-pages branch

The URL,https://konveyor.github.io/ is configured to serve the web assets from the gh-pages branch

Code of Conduct

Refer to Konveyor's Code of Conduct here.

DCO

Licensing is important to open source projects. It provides some assurances that the software will continue to be available based under the terms that the author(s) desired. We require that contributors sign off on commits submitted to our project's repositories. The Developer Certificate of Origin (DCO) is a way to certify that you wrote and have the right to contribute the code you are submitting to the project.

You sign-off by adding the following to your commit messages. Your sign-off must match the git user and email associated with the commit.

This is my commit message

Signed-off-by: Your Name <your.name@example.com>

Git has a -s command line option to do this automatically:

git commit -s -m 'This is my commit message'

If you forgot to do this and have not yet pushed your changes to the remote repository, you can amend your commit with the sign-off by running

git commit --amend -s