From 627d42a9d9e8d803d59af7a9ee6a4ce0b535c1d2 Mon Sep 17 00:00:00 2001 From: Ole Herman Schumacher Elgesem Date: Mon, 22 Jun 2026 20:05:42 +0200 Subject: [PATCH] README.md: Added instructions for build-locally.sh Signed-off-by: Ole Herman Schumacher Elgesem --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 2e913cb6a..67320d196 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,18 @@ It is in general advisable to make small commits that are submitted through pull requests frequently. Otherwise any structural changes to documentation content can cause merge conflicts that are hard to resolve. +## Building docs locally + +We provide a convenience script for building docs locally, using Docker; + +```bash +./build-locally.sh +``` + +For now, this will only work for CFEngine team members - you need to be able to clone the private (enterprise) repos with SSH. + +When the script finishes, it gives you instructions for how to start a webserver and see the resulting docs page. + ## Writing guidelines In order to make our documentation, blog posts, and website as consistent and easy to understand as possible, for both readers and writers, please follow the guidelines below.