honeycombio / terraform-provider-honeycombio

A Terraform provider for Honeycomb.io
https://registry.terraform.io/providers/honeycombio/honeycombio/latest
MIT License
48 stars 24 forks source link

Investigate generation of the documentation #57

Open kvrhdn opened 3 years ago

kvrhdn commented 3 years ago

It's apparently already possible to generate documentation based upon the various Description fields within the resource definitions.

To do:

Links https://github.com/hashicorp/terraform-plugin-docs https://github.com/hashicorp/terraform-provider-scaffolding/blob/main/main.go#L20

ryanking commented 2 years ago

I have done this before for the snowflake provider and would be happy to contribute a PR. Ok?

jharley commented 2 years ago

@ryanking I would love it!

dstrelau commented 10 months ago

Full auto-generated documentation now exists in the registry.

jharley commented 10 months ago

Miscommunication here: this is sadly still not true, I hope to get it done in the next few months.

jharley commented 3 months ago

Current guide to get this setup: https://developer.hashicorp.com/terraform/tutorials/providers-plugin-framework/providers-plugin-framework-documentation-generation