Build and serve the website locally

    To guarantee the tests you run locally use the same versions as the tests running on the Istio Continuous Integration (CI), we provide a Docker image with all the tools needed, including our site generator: .

    To build, test, and preview the site locally, you need to install Docker on your system.

    Preview your changes

    To preview your changes to the site, go to the root of your fork of and run the following command:

    If your changes have no build errors, the command builds the site and starts a local web server to host it. To see the local build of the site, go to http://localhost:1313 on your web browser.

    If you need to make and serve the site from a remote server, you can use ISTIO_SERVE_DOMAIN to provide the IP address or DNS Domain of the server, for example:

    We use linters and tests to ensure a quality baseline for the site’s content through automated checks. These checks must pass without failure for us to approve your contribution. Make sure you run the checks locally before you submit your changes to the repository through a PR. We perform the following automated checks:

    • HTML proofing: ensures all links are valid along with other checks.

    • Spell check: ensures content is spelled correctly.

    To run these checks locally, use the following command:

    • A real typo: Fix the typo on your Markdown files.

    • The error is reported for a command, field, or symbol name: Place `back-ticks` around the content with the error.

    Due to poor Internet connectivity, you could have trouble with the link checker. If you can’t get good connectivity, you can set the checker to prevent it from checking external links. Set the INTERNAL_ONLY environment variable to True when running the linter, for example:

    When your content passes all the checks, submit it to the repository through a PR. Visit for more information.