Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading