jrkinley / documentation

Public repo for Redpanda documentation.

This repository hosts the source code and content for the Redpanda documentation website.

The source code for the Redpanda product is hosted in the Redpanda product repository.

Website

This website is served at https://docs.redpanda.com

Local Development

This website is using Docusaurus 2, a modern static website generator.

If you want to run the website locally, install the packages:

npm install

Then you'll be able to start:

npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

To have a production ready build run:

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Hosting

This website is hosted at Netlify.

Style Guide

Before you add or edit content, consult the Redpanda Style Guide for product documentation guidelines.

Single-sourcing with partials

Practice the DRY (Don't Repeat Yourself) principle by single-sourcing repeated content. Common examples of single-sourced content include prerequisites, contact info, and foundational steps of how-to guides.