tfproviderdocs icon indicating copy to clipboard operation
tfproviderdocs copied to clipboard

check: Implement optional page content title Resource: and Data Source: prefix check

Open bflad opened this issue 5 years ago • 1 comments

In larger Terraform Providers, a common strategy to help operators distinguish between resource and data source pages has been adding a Resource: or Data Source: prefix to the page content title (the h1 header in the Markdown). This should be behind a check command flag for now such as -require-resource-page-title-prefix. If diagnostics are in place, then this should be enabled as a warning by default and the flag promotes it to an error.

Failing cases (either resource or data source file):

---
# ... Frontmatter ...
---

# example_thing

Byline.

Passing case (resource):

---
# ... Frontmatter ...
---

# Resource: example_thing

Byline.

Passing case (data source):

---
# ... Frontmatter ...
---

# Data Source: example_thing

Byline.

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