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

[Bug]: some documentation issues #757

Closed
zoro16 opened this issue Sep 21, 2023 · 1 comment · Fixed by #760
Closed

[Bug]: some documentation issues #757

zoro16 opened this issue Sep 21, 2023 · 1 comment · Fixed by #760
Assignees
Labels

Comments

@zoro16
Copy link

zoro16 commented Sep 21, 2023

What happened?

Hi,

I was going through the documentation and trying out creating resources and I found out the following issues.

Primary IP

https://registry.terraform.io/providers/hetznercloud/hcloud/latest/docs/resources/primary_ip

id is added as an Argument, but it's an invalid or unknown key

RDNS

https://registry.terraform.io/providers/hetznercloud/hcloud/latest/docs/resources/rdns

server_id - (Required, int) The server the ip_address belongs to. is unnecessarily add to most of the arguments.

Load Balancer Service

https://registry.terraform.io/providers/hetznercloud/hcloud/latest/docs/resources/load_balancer_service

  • load_balancer_id is listed as a (Required, string), but I think it should be and int
  • http and health_check arguments are listed as (Optional, list), but they are actually Blocks. Also an example for their use will be really appreciated.

Managed Certificate

https://registry.terraform.io/providers/hetznercloud/hcloud/latest/docs/resources/managed_certificate

Argument should be domain_names not domains

@apricote
Copy link
Member

Thanks a lot for the reports @zoro16, will be fixed by #760.

After we switch to the new plugin framework (#752) I hope we can also autogenerate our docs from the actual schema using terraform-plugin-docs to avoid these types of errors.

apricote added a commit that referenced this issue Sep 29, 2023
Fixes the docs issues reported in #757 and #758

Closes #757  
Closes #758
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants