Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inconsistent name between documentation and Terraform Registry #22

Open
adarobin opened this issue Mar 27, 2024 · 0 comments
Open

Inconsistent name between documentation and Terraform Registry #22

adarobin opened this issue Mar 27, 2024 · 0 comments
Labels
bug Bug needs-triage Needs Triage

Comments

@adarobin
Copy link

Describe the bug

The name of the provider and resources in the documentation compared to the Terraform Registry does not match.

For the provider itself, https://github.com/vmware/terraform-provider-nsxt-virtual-private-cloud/blob/main/website/docs/index.html.markdown states you should reference the provider as follows:

terraform {
  required_providers {
    nsxt = {
      source  = "vmware/nsxt-vpc"
      version = "1.0.0"
    }
  }
}

The Terraform Registry page for the provider has a "Use Provider" button which shows:

terraform {
  required_providers {
    nsxt-virtual-private-cloud = {
      source = "vmware/nsxt-virtual-private-cloud"
      version = "1.0.0"
    }
  }
}

As an example of a resource, there is documentation for a nsxt_vpc_gateway_policy_rule resource in https://github.com/vmware/terraform-provider-nsxt-virtual-private-cloud/blob/main/website/docs/r/nsxt_gateway_policy_rule.html.markdown. This documentation is rendered on the Terraform Registry page, but the Registry page itself shows the name of the resource is nsxt-virtual-private-cloud_nsxt_gateway_policy_rule.

Reproduction steps

n/a

Expected behavior

A consistent name is used in the documentation and the registry.

Additional context

No response

@adarobin adarobin added the bug Bug label Mar 27, 2024
@tenthirtyam tenthirtyam added the needs-triage Needs Triage label Oct 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Bug needs-triage Needs Triage
Projects
None yet
Development

No branches or pull requests

2 participants