vitessio/website

Vitess website is a static site generator built with Hugo that serves the project documentation and marketing content for the Vitess database clustering system.

The repository contains the source assets and configuration needed to build and maintain vitess.io. It uses Hugo as the static site generator, Bulma as the CSS framework, and includes tooling for link validation across internal and external URLs. The site supports dynamic content filtering through a search index system powered by Lunr, allowing users to filter learning resources by multiple criteria. Documentation versioning is managed through release scripts that handle both release candidate and general availability versions.

Teams adopting this repository should understand it is primarily a content and site management tool rather than a general-purpose static site generator. It suits organizations maintaining documentation for open-source projects, particularly those needing versioned documentation alongside marketing content. The repository includes specific workflows for adding user logos to a community section and for managing documentation releases, making it practical for projects with active contributor communities. Anyone considering use should be prepared to work with Hugo's templating system and understand the custom filtering logic built into the learning resources section.

The project maintains active development with regular updates to documentation structure and site features. Pull requests are accepted for community contributions such as adding user logos. The repository includes comprehensive tooling for site validation and maintenance, with documented procedures for common tasks like adding filter options and releasing new documentation versions. Release management is formalized through shell scripts that automate the process of creating release candidate and general availability versions.