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

Need clarification to reduce confusion from misleading auto-generated content in "USE PROVIDER" dropdown and the resources/datasources namings in the Terraform registry #25

Open
bczoma opened this issue Jul 11, 2024 · 1 comment
Labels
bug Something isn't working

Comments

@bczoma
Copy link
Collaborator

bczoma commented Jul 11, 2024

Bug Description

When clicking on "USE PROVIDER" the following information is given:

terraform {
  required_providers {
    solacebrokerappliance = {
      source = "SolaceProducts/solacebrokerappliance"
      version = "1.0.0"
    }
  }
}

provider "solacebrokerappliance" {
  # Configuration options
}

Also, the "Resources" and "Data sources" section entries contain wrong object names.

Expected Behavior

The example should suggest using provider "solacebroker", as in the example use section at https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs#example-usage

...
provider "solacebroker"  {
  # Configuration options
}

The "Resources" and "Data sources" section entries should start with solacebroker_ vs solacebrokerappliance.

Steps to Reproduce

Click on "USE PROVIDER" and also expand the "Resources" and "Data sources" section at https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs

Solace Broker version

No response

Solace API

No response

Solace API version

No response

@bczoma bczoma added the bug Something isn't working label Jul 11, 2024
@bczoma
Copy link
Collaborator Author

bczoma commented Jul 11, 2024

The plan is to add clarification to the "Overview documentation " at https://registry.terraform.io/providers/solaceproducts/solacebrokerappliance/latest/docs.

Also fix the link to "solacebroker provider" at
"This solacebrokerappliance provider uses the same preferred local name "solacebroker" as the solacebroker provider...."

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant