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

[Notice] Provider documentation on registry.terraform.io #3032

Open
xiehan opened this issue Jul 25, 2023 · 2 comments
Open

[Notice] Provider documentation on registry.terraform.io #3032

xiehan opened this issue Jul 25, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation notice Internal use only. An issue being used by the maintainers to flag something for the community.

Comments

@xiehan
Copy link
Member

xiehan commented Jul 25, 2023

We are excited to announce CDK for Terraform multi-language provider docs in the Terraform Registry. This helps you simplify infrastructure provisioning and improve productivity by offering provider configuration options and code samples for the programming languages supported by CDKTF alongside the HCL documentation in the registry.

If you are new to working with a particular resource in your preferred programming language, such as TypeScript, for example, you can copy-paste the code samples from the multi-language provider docs in the registry and then adapt them for your needs. This is especially useful when starting a new project — no mental translation required.

We are launching this feature with the following set of providers and resources and plan to gradually expand the documentation over time:

To view the new documentation, navigate to the Terraform Registry and then to the particular resource page you want to provision in your CDKTF project. For example, if you’d want to provision an Amazon EC2 Dedicated Host in TypeScript, you can now find the translated snippet in the Registry by selecting “TypeScript” in the language selection dropdown.

Terraform multi-language provider docs provide code samples in TypeScript and Python.

If you notice a problem with any of the TypeScript or Python code snippets, please file a documentation bug report and we'll investigate. Otherwise, feel free to comment on this issue with your feedback on the feature as well as requests for resources or providers you'd like us to add documentation to next. Note that for the foreseeable future, we're prioritizing adding documentation to the official HashiCorp providers; Partner and Community providers are not (yet) on the roadmap.

Adding code samples in Java, C# and Go is on the roadmap, but we do not currently have an ETA on when we'll be rolling that out. We need to do more work to ensure that the generated code in those languages is accurate and good-quality; we do not want to provide code snippets that are incorrect and won't work when copy-pasted into your project. We'll keep the community updated once we have an estimated timeline for when this support will be added.

In the meantime, we hope that for many of you, this will vastly improve your developer experience when working with CDKTF, and we look forward to hearing your feedback!

@xiehan xiehan added the notice Internal use only. An issue being used by the maintainers to flag something for the community. label Jul 25, 2023
@xiehan xiehan pinned this issue Jul 25, 2023
@xiehan xiehan changed the title [Notice] Documentation on registry.terraform.io [Notice] Provider documentation on registry.terraform.io Jul 25, 2023
@xiehan xiehan added the documentation Improvements or additions to documentation label Jul 25, 2023
@jsteinich
Copy link
Collaborator

Really nice to see this integration. A few initial thoughts:

  • Would be nice to reference the pre-built provider imports rather than locally generated since using pre-built providers is recommended
  • I'd prefer not having the full stack generated
  • Having the root provider page translated seems like a natural starting point. Ideally the use provider button would also switch

@evanstachowiak
Copy link

This has been really helpful. Glad to see CDKTF development continuing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation notice Internal use only. An issue being used by the maintainers to flag something for the community.
Projects
None yet
Development

No branches or pull requests

3 participants