https://github.com/inspec/chef-inspec-resource-docs
Documentation for InSpec resource packs
https://github.com/inspec/chef-inspec-resource-docs
Last synced: 4 months ago
JSON representation
Documentation for InSpec resource packs
- Host: GitHub
- URL: https://github.com/inspec/chef-inspec-resource-docs
- Owner: inspec
- License: cc-by-4.0
- Created: 2025-09-09T19:15:35.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-10-16T20:11:51.000Z (8 months ago)
- Last Synced: 2025-10-16T23:26:19.229Z (8 months ago)
- Language: Shell
- Homepage:
- Size: 3.82 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Chef InSpec resource pack documentation
This repository contains documentation for Chef InSpec resource packs.
## Local development environment
We use [Hugo](https://gohugo.io/), [Go](https://golang.org/), [NPM](https://www.npmjs.com/),
[go-swagger](https://goswagger.io/install.html), and [jq](https://stedolan.github.io/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](https://goswagger.io/install.html)
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](https://goswagger.io/install.html) to install go-swagger
1. (Optional) [Install cspell](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell)
To be able to run the optional `make spellcheck` task you'll need to install `cspell`:
```shell
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
#### Clean your local environment
To clean your local environment, run `make clean_all`.