nyoxi / konveyor.github.io

Documentation for Konveyor projects

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