gitmyhub

docs

Java ★ 69 updated 1d ago

Documentation for Redis, Redis Cloud, and Redis Enterprise

This repository holds the source files for the official Redis documentation website, covering Redis, Redis Cloud, and Redis Enterprise. It is not the Redis software itself but rather the content and site-building machinery that produces the pages on redis.io.

The site is built with Hugo, a tool that converts Markdown files into HTML pages. The repository is organized into folders for content (the actual documentation articles), layouts (HTML templates that control how pages look), assets (CSS and images), and data files used during the build. Node.js and Python are also part of the build process, mainly to pull in code examples from other repositories and handle styling through a CSS framework called Tailwind.

Contributors write or edit Markdown files and submit pull requests. Changes land on the main branch first, then the docs team periodically merges them into a branch called latest, which is what visitors actually see on the site. There can be a lag of several days between when a change is merged and when it appears publicly.

The build process is controlled by a Makefile. Running one command fetches dependencies, compiles CSS, pulls in external code samples, and generates the final HTML. A local development server lets contributors preview changes in a browser before submitting them.

The repository also includes a continuous integration pipeline that automatically builds the site and uploads the result to a Google Cloud Storage bucket whenever changes are pushed. This is how new content gets deployed to the live site.