gattie / sensu-docs

Documentation for Sensu

Welcome to the Sensu Docs project! This repository is the home of docs.sensu.io.

Read the docs | Contributing guide | Style guide | Code of conduct | Contact admins | Open an issue

---

We welcome all contributions! Read the contributing guide to get started.

For details on formatting and style, see the Sensu Docs style guide. If you have any questions, please submit an issue, or feel free to reach out in #documentation in the Sensu Community Slack.

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

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. Download

Download from GitHub or clone the repository:

git clone [email protected]:sensu/sensu-docs.git && cd sensu-docs

2. Install packages

This project uses Yarn to manage dependencies and the build process. For information on installing Yarn, view their documentation.

After installing yarn, run:

yarn

This will install Hugo and build the site into the public directory.

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.

Troubleshooting

Here are some things you might try if you encounter an issue working with the site:

• Run yarn hugo-version to print the running version of Hugo. Version 0.34 or newer is required.
• If you're seeing stale page content, try using yarn server --disableFastRender to 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!

Theme

This project uses a fork of the wonderful hugo-material-docs theme.

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.