hashicorp / hashicorp/terraform-plugin-docs

Allow setting subcategory from code

Open
#156 6 comments 19 reactions 0 assignees View on GitHub
enhancement
Dominant language
Go
Stars
263
Forks
84
Avg merge
3d 6h
Merged PRs (30d)
2

Description

Hi,

per the [docs](https://www.terraform.io/registry/providers/docs#subcategories), subcategories can be used to add some structure to the docs.
The default template defaults to `""`, which I could then manually adjust.

The problem with this is this: I maintain a provider with many external contributions are via pull requests. We have a pipeline that enforces that the documentation is updated by running `tfplugindocs` on the PR and then erroring if there are any changes. This means the author of the PR themselves must run `tfplugindocs` if they introduce a new attribute or resource to update the docs in their PR.

This means managing the subcategory manually is not an option.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.