coreybutler/spiffe.io

This repository holds the source code for the SPIFFE project's website, which is hosted at spiffe.io. SPIFFE is an open-source project backed by the Cloud Native Computing Foundation that deals with security and identity for software systems. The website serves as the public face of the project and also houses the documentation for SPIRE, which is the runtime environment that actually implements SPIFFE's specifications. The site is built using a static site generator called Hugo and styled with a framework called Bulma. Most of the actual content lives in simple text files using Markdown formatting. When someone merges changes into the main code branch, a service called Netlify automatically rebuilds and publishes the site in about a minute. Contributors can also run the site locally on their own machine to preview changes, using either a containerized setup or a local installation of the required tools. The people who would work with this repository are contributors to the SPIFFE project who want to update documentation, add their organization to the "Who uses SPIFFE?" list, or fix broken links. For example, if a new version of SPIRE is released, the site can automatically pull the latest version number and download links from GitHub. Someone editing the site would typically work with YAML data files and Markdown documents rather than writing complex code. A few things stand out about how the project is structured. The site has built-in tooling to crawl for broken links, which helps catch outdated URLs before they reach the live site. Some content is generated dynamically from external sources like the GitHub Releases API, so the Downloads page stays current without manual edits. By default, local development omits live release data to avoid hitting GitHub's rate limits for API requests.