tfproviderdocs icon indicating copy to clipboard operation
tfproviderdocs copied to clipboard

check: Implement Example Usage header check

Open bflad opened this issue 5 years ago • 1 comments

Terraform Provider resource/data source documentation pages should include an example usage section.

Failing case:

---
... Frontmatter ...
---

# Title

Byline

## Argument Reference

## Attribute Reference

Passing case:

---
... Frontmatter ...
---

# Title

Byline

## Example Usage

## Argument Reference

## Attribute Reference

bflad avatar Dec 16 '19 18:12 bflad

Experimental support for this has been added via new -enable-contents-check flag in version 0.8.0 of tfproviderdocs.

bflad avatar Oct 26 '20 20:10 bflad

This project will be archived in preference of the revamped validate command in github.com/hashicorp/terraform-plugin-docs implementing much of the basic validation logic from this project. Feature requests should be submitted over there at this point.

bflad avatar May 19 '24 19:05 bflad