terraform-plugin-docs
terraform-plugin-docs copied to clipboard
hashicorp
Generate and validate Terraform plugin/provider documentation.
This PR introduces a `--use-provider-prefix` flag for the `tfplugindocs generate` command. The flag defaults to false, in which case the command behavior around file names matches existing behavior. When the...
### Terraform CLI and terraform-plugin-docs Versions Terraform v1.6.2 ### Provider Code ```go n/a ``` ### Expected Behavior the markdowns generated need to reflect the source from the current project directory...
### Terraform CLI and terraform-plugin-docs Versions `terraform version Terraform v1.6.6 on darwin_arm64` `github.com/hashicorp/terraform-plugin-docs v0.18.0` ### Provider Code ```go https://registry.terraform.io/providers/duplocloud/duplocloud/latest/docs/resources/plan_certificates#certificate ``` ### Expected Behavior Marking the fields `id` as read only...
### Terraform CLI and terraform-plugin-docs Versions `github.com/hashicorp/terraform-plugin-docs v0.18.0` ### Use Cases or Problem Statement Bubbling up from this comment https://github.com/hashicorp/terraform-plugin-go/issues/267#issuecomment-1494874479 and a TODO in an error message here: https://github.com/hashicorp/terraform-plugin-docs/blob/6b686eefb31bc0d7e4e7a3a71952e98e882babef/schemamd/render.go#L86 Tuple...
### Terraform CLI and terraform-plugin-docs Versions `github.com/hashicorp/terraform-plugin-docs v0.18.0` ### Use Cases or Problem Statement Currently, when documenting a provider-defined function that has an object as a parameter or return type,...
Could you write an example about how tfproviderdocs would be supposed to work in a CI ? Either breaking if there is a diff between what tfproviderdocs should generate and...
Seems like right now tfplugindocs generate got hardcoded - plugins/registry.terraform.io/hashicorp/ for the providerPath, but in case of locally developed provider it's not a case. ``` $ tfplugindocs generate rendering website...
This PR updates the README to include the `go install` command to use to install `tfplugindocs`
The generated schema information contains anchors in the form of `` which are immediately followed by a markdown title in the form of `### Nested Schema for ...`. My expectation...
Take the following code snippet from a Terraform provider: ``` func resourceWizAutomationRuleServiceNowCreateTicket() *schema.Resource { return &schema.Resource{ Description: "Automation Rules define associations between actions and findings.", Schema: map[string]*schema.Schema{ "servicenow_summary": { Type:...
