This is repository is the source code for Kuma's documentation website. Kuma is a universal open source control-plane for Service Mesh and Microservices that can run and be operated natively across both Kubernetes and VM environments, in order to be easily adopted by every team in the organization. If you are looking for the source code instead, please check out Kuma's main repository.

This website is built on VuePress and is open-source for the community to contribute to. Feel free to submit an issue to propose changes or submit a patch if you want to write some code!

Contact and chat with the community in real-time if you get stuck or need clarifications. We are here to help.

• Installation
• Build
• Test

After you forked and cloned the repository, follow the steps below to setup the local dev environment.

yarn install

yarn docs:dev

You can now navigate to http://localhost:8080/.

yarn docs:build

This creates a dist folder within .vuepress. This script is good in case you want to test the compiled site locally with something like http-server.

The Docs and Install pages have 301 redirects that ensure their bare URLs always go to the latest version of Kuma. Because of the order in which Netlify deployment and build functions are run, the full deployment build script is handled within the netlify.toml file.

At the top of our netlify.toml file, there is a build script under [build].

It will:

1. Run the setup-redirects Node script, which writes the appropriate redirects in Netlify format to the end of the netlify.toml file
2. Runs vuepress build docs which will build the site accordingly

After you make changes to the code, run the following command to run any existing and new tests:

yarn test

Before submitting a pull request, make sure all tests are passing.