Chef InSpec resource pack documentation

This repository contains documentation for Chef InSpec resource packs.

Local development environment

We use Hugo, Go, NPM, go-swagger, and jq. You will need Hugo 0.146 or higher installed and running to build and view our documentation properly.

To install Hugo, NPM, and Go on Windows and macOS:

• On macOS run: brew tap go-swagger/go-swagger && brew install go-swagger hugo node go jq
• On Windows run: choco install hugo nodejs golang jq
  • See the Go-Swagger docs to install go-swagger

To install Hugo on Linux, run:

• apt install -y build-essential
• sudo apt-get install jq
• snap install node --classic
• snap install hugo --channel=extended
• See the Go-Swagger docs to install go-swagger

1. (Optional) Install cspell

   To be able to run the optional make spellcheck task you'll need to install cspell:

   npm install -g cspell

Preview InSpec documentation

Use one of the following methods to preview the documentation in inspec/chef-inspec-docs:

• submit a pull request
• run make serve

Submit a PR

When you submit a PR to inspec/chef-inspec-docs, Netlify builds the documentation and add a notification to the GitHub pull request page. You can review your documentation changes as they would appear on docs.chef.io.

make serve

• Run make serve
• go to http://localhost:1313

Clean your local environment

To clean your local environment, run make clean_all.