terraform-plugin-docs
terraform-plugin-docs copied to clipboard
hashicorp
Generate and validate Terraform plugin/provider documentation.
The [AWS provider resource docs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/redshift_cluster#timeouts) show not only which timeouts are supported -but also their default values from code. This would be a great addition to tfplugindocs.
The order of the attributes in the schema rendered as a document is very difficult to see. For consistency, sorting by attribute name makes it easier to view as a...
I'm pretty sure that terraform-plugin-docs adds the validator docstrings to a param's docstring when the provider is built using SDKv2, but this is not happening for my provider built using...
Are there any plans to support documentation generation for Terraform Module codebases in the same fashion as providers?
This patch adds a --subcategory flag that let users give a mapping that will use to set the `subcategory` field in the documentation: tfplugindocs generate --subcategory consul_acl=ACL --subcategory consul_admin="Admin Partition"...
This is missing from the website, not sure where to reach out. AFAICT the way to publish docs is - Docs are in `/docs` at top level of repo -...
### Terraform CLI and terraform-plugin-docs Versions terraform v1.8.1 terraform-plugin-docs v0.19.4 ### Provider Code ```go https://github.com/equinix/terraform-provider-equinix ``` ### Expected Behavior When I run `terraform-plugin-docs migrate`, the templates and examples that are...
### Terraform CLI and terraform-plugin-docs Versions `github.com/hashicorp/terraform-plugin-docs v0.19.3` ### Use Cases or Problem Statement Currently, when the `tfplugindocs` commands are executed there are no exit codes to explicitly indicate whether...
This renders blocks in a separate _Blocks_ section to avoid all blocks being rendered as optional in resources implemented with terraform-plugin-framework. Also renames _Required_ and _Optional_ sections to _Required Attributes_...
### Terraform CLI and terraform-plugin-docs Versions Terraform v1.8.2 on darwin_arm64 require github.com/hashicorp/terraform-plugin-docs v0.19.1 ### Provider Code ```go func (r *networkResource) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = schema.Schema{...