terraform-provider-hetznerdns icon indicating copy to clipboard operation
terraform-provider-hetznerdns copied to clipboard

Add more examples to the doc

Open c33s opened this issue 3 years ago • 7 comments

a out of the box working example with everything needed to create a zone, a record and assign it to a host would be awesome (see #14 xD)

c33s avatar Sep 07 '20 07:09 c33s

Did you notice the examples in the docs? The record and zone docs both have an example showing how to use them.

timohirt avatar Sep 07 '20 19:09 timohirt

yes i noticed them, thank you. what i ment is that the first page example should be a full working real world copy and paste example. so no clicking around just copy and paste and you are good to go. what do you think about that?

c33s avatar Sep 07 '20 20:09 c33s

Yes, that's a good idea. I understand that the current example requires an already created zone (see here).

I would add another example which defines both, a zone and a record. It will never be copy and paste as I don't know the zone of a user. But I think that would be fair enough. What do you think?

timohirt avatar Sep 07 '20 20:09 timohirt

what about a fill example with the zone name example.com so you don't need to know the zone names but it's still a working copy and paste example. also i would go for a full zone example including spf and mx record. such full examples are still the best documentation.

c33s avatar Sep 09 '20 15:09 c33s

what about a fill example with the zone name example.com so you don't need to know the zone names but it's still a working copy and paste example. also i would go for a full zone example including spf and mx record. such full examples are still the best documentation.

@timohirt I made some quick examples of how to use this plugin. What do you think? #21

JonasKop avatar Nov 06 '20 18:11 JonasKop

gif

Merged the PR. Thank you for adding the examples. I'll release a new version of the provider shortly. Then the documentation on Terraform Registry will update as well.

timohirt avatar Nov 09 '20 19:11 timohirt

@timohirt I think you can close this issue :) Since we now use this provider too for about 50 domains with terraform and Gitlab, I could also add some more examples like CAA and so on. Let me know if you're interested.

martinseener avatar Feb 08 '22 15:02 martinseener