Update Hugo resource archetype

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
This commit is contained in:
Ian Maddaus 2022-04-06 16:32:12 -04:00
parent 79d3a6e342
commit f1218c19a4
2 changed files with 69 additions and 6 deletions

View file

@ -1,12 +1,74 @@
+++
title = "{{ or (replace .Name "_" " ") (replace .Name "-" " ") | title }}"
title = "{{ .Name }} resource"
draft = false
platform = "<platform>"
gh_repo = "inspec"
platform = "<PLATFORM>"
[menu]
[menu.desktop]
title = "{{ replace .Name "-" " " | title }}"
identifier = "inspec/resources/{{ .Name }}.md {{ or (replace .Name "_" " ") (replace .Name "-" " ") | title }}"
parent = "inspec/resources"
[menu.inspec]
title = "{{ .Name }}"
identifier = "inspec/resources/<PLATFORM>/{{ .Name }}"
parent = "inspec/resources/<PLATFORM>"
+++
{{/* Run `hugo new -k resource inspec/resources/RESOURCE_NAME.md` to generate a new resource page. */}}
Use the `{{ .Name }}` Chef InSpec audit resource to test the configuration of...
## Installation
{{% inspec_installation %}}
This resource first became available in Chef InSpec vX.Y.Z.
## Syntax
```ruby
describe {{ .Name }} do
#...
end
```
## Parameters
`PARAMETER`
: PARAMETER DESCRIPTION
`PARAMETER`
: PARAMETER DESCRIPTION
## Properties
`PROPERTY`
: PROPERTY DESCRIPTION
`PROPERTY`
: PROPERTY DESCRIPTION
## Examples
**EXAMPLE DESCRIPTION**
```ruby
describe {{ .Name }} do
#...
end
```
**EXAMPLE DESCRIPTION**
```ruby
describe {{ .Name }} do
#...
end
```
## Matchers
{{% inspec_matchers_link %}}
**MATCHER_NAME**
The `MATCHER_NAME` matcher tests the value of...
```ruby
its(`MATCHER_NAME`) { should cmp 'VALUE' }
```

View file

@ -0,0 +1 @@
This resource is distributed along with Chef InSpec itself. You can use it automatically.