Kiali.io

This repository contains the source code for the http://kiali.io website.

The website is written using markdown, the Docsy theme, and generated using Hugo. It is hosted on Github and deployed using netlify.

Table of Contents

• Requirements
• Configuring and Running
• Upgrading Hugo Version
• Documentation Versioning
• Production Deployment
• Directory Structure
• License and Code of Conduct

Requirements

To run the website locally, you will need:

• Podman or Docker
• GNU Make

Generally podman is easier to setup.

Configuring and Running

Hugo has a command to run a small, self-contained web server locally, so you can test the website without having to upload/deploy it anywhere. The server supports live-reload, so changes to the content will reflect into the browser as they happen.

To run the server, you need to run the following on a terminal:

make serve

⚠️ If you are using Docker, you need to set DORP when starting the server; e.g:

make -e DORP=docker serve

On ARM-based Macs, you'll need to run following command first:

export DOCKER_DEFAULT_PLATFORM=linux/amd64

If everything is working as expected, you should see something like this (if not see Upgrading Hugo Version):

                   | EN
-------------------+------
  Pages            | 151
  Paginator pages  |   0
  Non-page files   |   1
  Static files     | 323
  Processed images |   2
  Aliases          |   4
  Sitemaps         |   1
  Cleaned          |   0

Built in 1313 ms
Environment: "development"
Serving pages from memory
Web Server is available at http://localhost:1313/ (bind address 0.0.0.0)
Press Ctrl+C to stop

The server should be available on http://localhost:1313. Some files might not be supported for live reload. If, for some reason, you are not seeing your changes appearing you may need to restart the server.

Upgrading Hugo version

The current version of Hugo used to build the site is defined in netlify.toml and in the Makefile. Make sure the versions defined in both places are the same or, at minimum, compatible. If make serve fails you may need to upgrade Hugo.

When upgrading to a new version of Hugo, change the versions in both files mentioned above and then rebuild your dev container image by passing in -e FORCE_BUILD=true when running make (e.g. make -e FORCE_BUILD=true build-hugo).

Documentation Versioning

The documentation is versioned using a branch strategy. The staging branch holds all new content. On each Kiali release staging will be captured in the current branch and the former current branch will be captured in a versioned branch. This typically happens every three weeks. Changes to staging will be applied to all future releases. Backport or update the current, or any other versioned branch, as needed.

Production Deployment

Deployment is done automatically when a pull request is merged, and preview deployments are also done for each PR, so you can verify that your changes will work in production before actually deploying.

Directory Structure

The directory structure is typical for projects using the Docsy theme. A couple of notes:

• The site only supports English and as such, all content is under content/en.
• The site minimizes customization but custom CSS is found in assets/scss.
• The site keeps consolidates static content under static.
  • e.g. images are under static\images

License and Code of Conduct

The kiali.io website, like the other kiali-related projects are licensed under the Apache License 2.0. It also follows the Kiali Community Code of Conduct.