terraform-plugin-docs
terraform-plugin-docs copied to clipboard
hashicorp
Generate and validate Terraform plugin/provider documentation.
## Current behavior The descriptions of the nested elements are only rendered in the markdown of the ` resources`, but not the `datasources`. - The schema: ```go "ipam_config": { Type:...
The readme describes using resource examples in `examples/resources//resource.tf`, but if I template `{{ printf "%s" .ExampleFile }}` it seems just to be `""` for resources. After a quick look at...
example: ``` // service_account resource schema func (r serviceAccountResourceType) GetSchema(_ context.Context) (tfsdk.Schema, diag.Diagnostics) { return tfsdk.Schema{ MarkdownDescription: "Service account resource", Attributes: map[string]tfsdk.Attribute{ "id": { Type: types.StringType, Computed: true, MarkdownDescription: "Server...
I have a Terraform Provider which needs special _tags_ to build. These _tags_ I can pass to: > go run -tags containers_image_openpgp github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs The problem is though, that tfplugindocs does...
`(Block List)` as a type rendered in documentation makes sense to the maintainer of a provider, but IMO it's confusing or even misleading to the end user. Concrete example here:...
Running the `tfplugindocs` from the root of any provider repo generates the following error: ``` ❯ tfplugindocs rendering website for provider "terraform-provider-scaffolding" exporting schema from Terraform compiling provider "scaffolding" Error...
As mentioned in #10: > deprecation messages are not included in the schema exported from Terraform, only a bool indicating its deprecated I propose making this bool available in the...
I've setup a `docs/guides` folder containing human written content. When I run the go generate command, the guides subfolder is deleted.
It would be useful to have at generation time a set of warnings when markdown is not properly linted. Similar to the features provided by: https://github.com/bflad/tfproviderdocs
