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.
Running the site locally
Download from GitHub or clone the repository:
git clone email@example.com:sensu/sensu-docs.git && cd sensu-docs
2. Install packages
After installing yarn, run:
This will install Hugo and build the site into the
3. Run the site locally
If the site builds successfully, you can run the Hugo server and view the site in a local web browser:
yarn run server
Then visit http://localhost:1313/ in the browser of your choice.
Here are some things you might try if you encounter an issue working with the site:
yarn hugo-versionto print the running version of Hugo. Version 0.34 or newer is required.
- If you're seeing stale page content, try using
yarn server --disableFastRenderto ensure all pages are rebuilt as you make changes.
- If you're still having trouble viewing the site, open an issue, and we'll be happy to help!
Deploying the site
Any time changes are merged to the
master branch, this project is automatically deployed to docs.sensu.io using Heroku's own Github integration. For additional details on Heroku configuration and deployment, see our wiki page.