Integrations > Custom Framework vs Custom SDK about terraform-docs-common HOT 5 CLOSED

Hi @rjhornsby 👋 Thank you for raising this issue as the tutorial content is not open source at this time.

It's a great idea that these tutorials should be more prescriptive about the preference of framework provider development over SDK provider development. We had planned on updating each the SDK tutorials to have a callout pointing to the framework tutorials with similar text to what you found, but I'm personally unsure the status of those tutorial updates. I will followup internally to ensure these updates occur to reduce confusion.

Out of curiosity, I'm wondering if:

I went looking for docs on writing a custom TF provider, and found https://developer.hashicorp.com/terraform/tutorials/provider

Was this through a search engine or similar? We would definitely love to point developers at the framework tutorials where possible and insight into how they might still be pointed at the older tutorials is greatly appreciated.

Thanks again!

from terraform-docs-common.

Ah ha, it turns out those updates did happen to the individual tutorial pages (e.g. the callout box near the top of https://developer.hashicorp.com/terraform/tutorials/providers/provider-use) but not the collection page. I'll see what can happen here -- the collection page content might be a little more limited in what can be put there, so it might wind up being normal text instead of a callout.

from terraform-docs-common.

Was this through a search engine or similar?

IIRC it was a Google search result, but now I can't seem to figure out what terms I used or how I ended up on that specific page. I can see where I was trying to figure out the difference between the framework and the SDK, but not how I landed on the page that led me to trying to sort that out. Sorry that's not helpful.

it might wind up being normal text instead of a callout.

That seems fine. Google is really good about search results for deprecated APIs, SDKs, etc showing up near the top unless you're super specific. I end up hitting this constantly with AWS documentation. So any additional remarks on the page - callout or otherwise - that say "hey, btw, we suggest the Framework" would be helpful.

from terraform-docs-common.

The additional information is very appreciated, thanks so much @rjhornsby 👍

from terraform-docs-common.

All set! https://developer.hashicorp.com/terraform/tutorials/providers

In these tutorials, learn how Terraform interacts with APIs and write a provider based on the prior plugin SDK. To create a new Terraform provider, please follow the Custom Framework Providers tutorials instead.

Thank you again.

from terraform-docs-common.