Welcome to the Sensu Docs project! This repository is the home of docs.sensu.io.
We welcome all contributions! Read the contributing guide to get started.
Contributing quick start
From the docs site, select "Edit this page" to go to the corresponding markdown file in GitHub. From there, GitHub will prompt you to create a fork and submit a pull request. You can also submit documentation feedback by opening an issue.
Run the Sensu Docs site locally
The Sensu Docs site is a static site built with Hugo and markdown. These instructions will help you get the site running locally.
To contribute to the Sensu Docs, please read the contributing guide.
1. Install Git and Yarn
2. Clone the Sensu Docs repo
You can clone the repo using either HTTPS or SSH.
Clone using HTTPS:
git clone https://github.com/sensu/sensu-docs.git && cd sensu-docs
Clone using SSH:
git clone email@example.com:sensu/sensu-docs.git && cd sensu-docs
If you prefer, download the repo from GitHub.
This will install Hugo and build the site into the
4. Run the site locally
If the site builds successfully, run:
yarn run server
This builds the Hugo server so you can view the site in your local web browser at http://localhost:1313/.
Here are some things to try if you encounter an issue working with the site:
yarn hugo-versionto print the running version of Hugo. Version 0.56.1 or newer is required.
- If you're still having trouble viewing the site, open an issue, and we'll be happy to help!
Developing Offline Docs
Offline documentation uses a set of layouts located in the
offline directory. To preview them:
yarn run server --layoutDir=offline
To exclude content from the offline documentation, the following can be added to a markdown file's front matter: