Kiali.io

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

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

The website is written using AsciiDoc, generated using Hugo, hosted on Github and deployed using netlify.

Requirements

To run the website locally, you will need:

• Docker or Podman

• GNU Make

Generally podman is easier to setup, but less used due to being newer.

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

Note	If you are using podman, you need to set CONTAINER_RUNTIME when starting the server, as such:

CONTAINER_RUNTIME=podman make serve

If everything is working as expected, you should see something like this:

                   |  EN
+------------------+------+
  Pages            | 1353
  Paginator pages  |    0
  Non-page files   |    0
  Static files     |  119
  Processed images |    0
  Aliases          |  155
  Sitemaps         |    1
  Cleaned          |    0

Total in 15304 ms
Watching for changes in /site/{content,data,layouts,static,themes}
Watching for config changes in /site/config.toml
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.

Documentation Versioning

The documentation is versioned, and all new changes should go to content/documentation/staging. The release script runs every 3 weeks usually and generates a content/documentation/vX.X with the contents of staging, as well as creating a symbolic link on content/documentation/latest.

The versioning/release script can be found on scripts/build-archive.sh.

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

• archetypes :: Content definitions, tag, categories and so on

• content :: Content for the website (pages and articles)

  • contribute :: Contribution how-to

  • documentation :: Documentation for Kiali

    • staging :: The documentation for the next released versions, changes should go here

    • latest :: A symbolic link to the latest generated version, replaced on release

    • vX.X :: Documentation for older versions, those are usually generated by the release scripts

  • news :: News about the project

• data :: Website data, such as localization configuration

• layouts :: Page layout templates

• public :: Content for website automatically generated by Hugo, it is not included in the repository

• scripts :: Scripts for generating swagger documentation and versioning

• static :: Any static files that need to be added to the website (images, css and js)

• themes :: The website theme

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.