The Vitess website

This repo houses the assets used to build the website at https://vitess.io.

Running the site locally

First install npm, then fetch dependencies, including Hugo by running these commands:

cd website
npm install

To build a development version of the site, run the following command:

make build

To serve the site locally, run:

make serve

View the locally served site at http://localhost:1313.

Adding a user logo

If you'd like to add your logo to the Who uses Vitess section of the website, add a PNG, JPEG, or SVG of your logo to the static/img/logos/users directory in this repo and submit a pull request with your change. Name the image file something that reflects your company (e.g., if your company is called Acme, name the image acme.png).

Link checking

You can check the site's internal links by running make check-internal-links and all links—internal and external—by running make check-all-links.

CSS/SASS

The Vitess website uses Bulma, a CSS (and SASS) framework that provides all kinds of variables, utilities, and components.

Releasing a new version of the documentation

To release a new version of the documentation you can use one of the following two scripts:

• ./tools/rc_release.sh: for RC release.

  • Takes one argument, the number of the next release.
  • Usage when releasing v16.0.0-rc1: ./tools/rc_release.sh "17"

• ./tools/ga_release.sh: when a version becomes GA.

  • Takes one argument too, the number of the version we are making GA.
  • Usage when releasing v16.0.0 GA: ./tools/ga_release.sh "16"