How to Contribute

Mon, 01 Jan 0001 00:00:00 +0000

Contributing to the Docs

To contribute to the kiali.io docs see kiali.io on github.

In short you will:

Fork the kiali.io repo on GitHub.
Make your changes and send a pull request (PR).
If you’re not yet ready for a review, add “WIP” to the PR name to indicate it’s a work in progress.
1. Don’t add the Hugo property “draft = true” to the page front matter, it prevents auto-deployment of the content preview.
Wait for the automated PR workflow to do some checks. When it’s ready, you should see a comment like this: deploy/netlify — Deploy preview ready!
Click Details to the right of “Deploy preview ready” to see a preview of your updates.
Continue updating your doc and pushing your changes until you’re happy with the content.

If you’ve just spotted something you’d like to change while using the docs, there is a shortcut for you:

Mon, 01 Jan 0001 00:00:00 +0000

In this section it is explained how to set up a development environment:

As described in Architecture, we would need to have the Kiali dependencies running in an OpenShift or Kubernetes
We will use a port forward to access those services outside the cluster.
We will have the project source running locally. In this case we will set up an IDE.
Bookinfo application example will also be running on our cluster.